Obtaining Job Details
Function
Obtain job details.
URI
GET /v1/{project_id}/cae/jobs/{job_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. See Obtaining a Project ID. |
job_id |
Yes |
String |
Job ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token.
|
X-Enterprise-Project-ID |
No |
String |
Enterprise project ID.
NOTE:
For details about how to obtain enterprise project IDs and enterprise project features, see Enterprise Management User Guide.
|
X-Environment-ID |
Yes |
String |
Environment ID.
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
api_version |
String |
API version. Fixed value: v1. |
kind |
String |
API type. Fixed value: Job. |
spec |
JobSpec object |
Job specifications. |
Parameter |
Type |
Description |
---|---|---|
progress |
Number |
Job progress. |
status |
String |
Task status.
|
tasks |
Array of Task objects |
Sub-job. |
Example Requests
Obtain job details.
GET https://{endpoint}/v1/{project_id}/cae/jobs/{job_id}
Example Responses
Status code: 200
OK
{ "api_version" : "v1", "kind" : "Job", "spec" : { "progress" : 0, "status" : "running", "tasks" : [ { "index" : 1, "name" : "upgrade", "status" : "init", "detail" : "", "created_at" : "2023-02-16T11:24:07.950175Z", "updated_at" : "2023-02-16T11:24:07.950175Z" } ] } }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot