Updated on 2026-04-10 GMT+08:00

Obtaining Job Details

Function

This API is used to obtain job details.

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the permission listed below is required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    servicestage:app:listApplication

    list

    -

    -

    servicestage:app:list

    -

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Tenant's project ID. See Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

job_id

Yes

String

Definition

Deployment job ID, which is job_id in the response parameter in Creating an Application Component, Importing a CCE Workload to an Application to Create a Component, Modifying Component Information Based on the Component ID, and Delivering a Component Task Based on the Component ID.

Range

N/A

Default Value

N/A

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

Definition

Message body type (or format).

Constraints

N/A

Range

application/json;charset=utf8

Default Value

N/A

X-Auth-Token

Yes

String

Definition

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.

Constraints

N/A

Range

N/A

Default Value

N/A

Response

Table 4 Response parameters

Parameter

Type

Description

task_count

Integer

Definition

Number of tasks.

Range

N/A

job

Object

Definition

Job parameters. See Table 5.

tasks

Array of objects

Definition

Task parameters. See Table 6.

Table 5 job

Parameter

Type

Description

execution_status

String

Definition

Execution status.

Range

  • SUBMITTED
  • SCHEDULED
  • RUNNING
  • FAILED
  • SUCCEEDED
  • CANCELLED
  • PARTIALLY_FAILED
  • ROLLBACKING
  • ROLLBACKED
  • UNKNOWN

job_id

String

Definition

Job ID.

Range

N/A

job_type

String

Definition

Type.

Range

  • PROVISION
  • DEPROVISION
  • DAILY_OPERATION
  • SYSTEM_INNER
  • UNKNOWN
Table 6 task

Parameter

Type

Description

created_at

String

Definition

Creation time.

Range

N/A

messages

String

Definition

Message.

Range

N/A

task_id

String

Definition

Task ID.

Range

N/A

task_index

Integer

Definition

Task index.

Range

N/A

task_name

String

Definition

Task name.

Range

N/A

task_status

String

Definition

Task status.

Range

  • SUBMITTED
  • SCHEDULED
  • RUNNING
  • FAILED
  • SUCCEEDED
  • CANCELLED
  • PARTIALLY_FAILED
  • SKIPPED
  • ROLLBACKING
  • ROLLBACKED
  • UNKNOWN

update_at

String

Definition

Update time.

Range

N/A

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
}

Status Code

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Code

See ServiceStage Error Codes.