Obtaining Job Details

Function

This API is used to obtain job details.

URI

GET /v3/{project_id}/cas/jobs/{job_id}

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant's project ID. See Obtaining a Project ID.
job_id	Yes	String	Deployment job ID, which is job_id in the response parameter in Creating an Application Component, Modifying Component Information Based on the Component ID, and Delivering a Component Task Based on the Component ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of specified records.
offset	No	Integer	Offset.
desc	No	String	Whether query results are displayed in descending order. Value: true (descending order) or false (ascending order).

Request

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format). Default value: application/json;charset=utf8.
X-Auth-Token	Yes	String	API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain the token, see Authentication.

Response

**Table 4** Response parameters
Parameter	Type	Description
task_count	Integer	Number of tasks.
job	Object	Job parameters. See Table 5.
tasks	Array<Object>	Task parameters. See Table 6.

**Table 5** job
Parameter	Type	Description
EXECUTION_STATUS	String	Execution status. SUBMITTED SCHEDULED RUNNING FAILED SUCCEEDED CANCELLED PARTIALLY_FAILED ROLLBACKING ROLLBACKED UNKNOWN
JOB_ID	String	Job ID.
JOB_TYPE	String	Type. PROVISION DEPROVISION DAILY_OPERATION SYSTEM_INNER UNKNOWN
ORDER_ID	String	Order ID.
PROJECT_ID	String	Tenant's project ID.
SERVICE_INSTANCE_ID	String	Instance ID.

**Table 6** task
Parameter	Type	Description
CREATED_AT	String	Creation time.
MESSAGES	String	Message.
TASK_ID	String	Job ID.
TASK_INDEX	Integer	Task index.
TASK_NAME	String	Task name.
TASK_STATUS	String	Task status. SUBMITTED SCHEDULED RUNNING FAILED SUCCEEDED CANCELLED PARTIALLY_FAILED SKIPPED ROLLBACKING ROLLBACKED UNKNOWN
UPDATE_AT	String	Update time.

Example Request

None

Example Response

{
    "job": {
        "execution_status": "SUCCEEDED",
        "job_id": "JOB17cb1778-07b1-4c8f-a183-c86cffbe8f9e",
        "job_type": "PROVISION"
    },
    "tasks": [
        {
            "task_id": "Task-af75dd60-0b04-4f4b-b669-0bad38fcdd97",
            "task_index": 4,
            "task_name": "VMAPP_CONTEXT_PREPARE_01",
            "task_status": "SUCCEEDED",
            "created_at": "2024-06-06T15:55:31.115Z",
            "update_at": "2024-06-06T15:55:31.136Z",
            "messages": "{}"
        },
        {
            "task_id": "Task-50110d26-3973-49e1-95d3-d46755e865af",
            "task_index": 5,
            "task_name": "VMAPP_UPGRADE_002",
            "task_status": "SUCCEEDED",
            "created_at": "2024-06-06T15:55:31.136Z",
            "update_at": "2024-06-06T15:55:31.36Z",
            "messages": "{}"
        }
    ],
    "task_count": 2
}