Updated on 2025-11-20 GMT+08:00

Querying a Job

Function

This API is used to query the details of a job in a specified project.

Calling Method

For details, see Calling APIs.

Authorization Information

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

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /autopilot/v2/projects/{project_id}/jobs/{job_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Details:

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Constraints:

None

Options:

Project IDs of the account

Default value:

N/A

job_id

Yes

String

Definition

Job ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Details:

The request body type or format

Constraints:

The GET method is not verified.

Options:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

  • multipart/form-data (used when the FormData parameter is present)

Default value:

N/A

X-Auth-Token

Yes

String

Details:

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

Constraints:

None

Options:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

kind

String

Definition

API type.

Constraints

N/A

Range

N/A

Default Value

Job

apiVersion

String

Definition

API version.

Constraints

N/A

Range

N/A

Default Value

v2

metadata

V2JobTypeObject object

Definition

Job metadata.

Constraints

N/A

Range

N/A

Default Value

N/A

spec

V2JobSpec object

Definition

Job details.

Constraints

N/A

Range

N/A

Default Value

N/A

status

V2JobStatus object

Definition

Job status.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 4 V2JobSpec

Parameter

Type

Description

type

String

Definition

Job type.

Constraints

N/A

Range

N/A

Default Value

N/A

clusteruid

String

Definition

Cluster ID.

Constraints

N/A

Range

N/A

Default Value

N/A

resourceid

String

Definition

Resource ID.

Constraints

N/A

Range

N/A

Default Value

N/A

resourcename

String

Definition

Resource name.

Constraints

N/A

Range

N/A

Default Value

N/A

extendparam

Map<String,String>

Definition

Job scale-out parameters.

Constraints

N/A

Range

N/A

Default Value

N/A

subjobs

Array of V2Job objects

Definition

Subjob details list.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 5 V2Job

Parameter

Type

Description

kind

String

Definition

API type.

Constraints

N/A

Range

N/A

Default Value

Job

apiVersion

String

Definition

API version.

Constraints

N/A

Range

N/A

Default Value

v2

metadata

V2JobTypeObject object

Definition

Job metadata.

Constraints

N/A

Range

N/A

Default Value

N/A

spec

V2JobSpec object

Definition

Job details.

Constraints

N/A

Range

N/A

Default Value

N/A

status

V2JobStatus object

Definition

Job status.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 6 V2JobTypeObject

Parameter

Type

Description

uid

String

Definition

Job UUID.

Constraints

N/A

Range

N/A

Default Value

N/A

creationTimestamp

String

Definition

Job creation time.

Constraints

N/A

Range

N/A

Default Value

N/A

updateTimestamp

String

Definition

Last update time of a job.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 7 V2JobStatus

Parameter

Type

Description

status

String

Definition

Job status.

Constraints

N/A

Range

  • Initializing: The job is not executed.

  • Running: The job is being executed.

  • Failed: The job fails to be executed.

  • Success: The job has been executed.

Default Value

N/A

reason

String

Definition

Cause of a job execution failure.

Constraints

N/A

Range

N/A

Default Value

N/A

completionTime

String

Definition

Job completion time.

Constraints

N/A

Range

N/A

Default Value

N/A

Example Requests

None

Example Responses

Status code: 200

{
  "kind" : "Job",
  "apiVersion" : "v2",
  "metadata" : {
    "uid" : "e43c6f3b-87e6-11f0-be88-0255ac10003f",
    "creationTimestamp" : "2025-09-02 10:23:38.987955 +0000 UTC",
    "updateTimestamp" : "2025-09-02 11:26:03.218087 +0000 UTC"
  },
  "spec" : {
    "type" : "ScaleupCluster",
    "clusteruid" : "7ec8b73d-83db-11f0-8baa-0255ac10003e",
    "resourceid" : "3b4410fa-87e6-11f0-be88-0255ac10003f",
    "resourcename" : "node-iv28j9",
    "extendparam" : {
      "claimrollback" : "true",
      "node.zone" : "cn-north-7c",
      "nodepooluid" : "",
      "orderID" : "CS25090218238EI5V",
      "v3-scaleup" : "true"
    }
  },
  "status" : {
    "status" : "Failed",
    "reason" : "Something bad happened at server, recycle resource",
    "completionTime" : "2025-09-02 11:26:03.218087 +0000 UTC"
  }
}

Status Codes

Status Code

Description

200

-

Error Codes

See Error Codes.