Describe Job
GET
/v2/jobs/{JOB_ID}The base URL for this API is in the following format:
https://api.cloud.zilliz.com
export BASE_URL="https://api.cloud.zilliz.com"
Parameters
Authorizationstringheaderrequired
The authentication token should be an API key with appropriate privileges.
Example Value: Bearer {{TOKEN}}
JOB_IDstringpathrequired
The ID of the job that has been submitted.
Example Value: job-xxxxxxxxxxxxxxxxxx
export TOKEN="YOUR_API_KEY"
export JOB_ID="job-xxxxxxxxxxxxxxxxxx"
curl --request GET \
--url "${BASE_URL}/v2/jobs/${JOB_ID}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"
Responses200 - application/json
jobIdstring
The ID of the job that has been submitted.
typestring
The type of the job
statusstring
The status of the job
progressstring
The progress of the job
startTimestring
The time at which the job starts.
endTimestring
The time at which the job end.
reasonstring
The message of why the job failed.
Returns an error message.
codeinteger
Response code.
messagestring
Error message.
{
"code": 0,
"data": {
"jobId": "job-03e1eefbd82dmo2oeb8pe2",
"type": "MIGRATION",
"status": "SUCCESSFUL",
"progress": "100",
"startTime": "2024-07-30T16:49:50Z",
"endTime": "2024-07-30T17:30:50Z",
"reason": ""
}
}