Updated on 2024-12-05 GMT+08:00

List Job Status

Function

This API is used to obtain job status.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

job_id

Yes

String

job id

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code

Minimum: 8

Maximum: 36

error_msg

String

Description

Minimum: 2

Maximum: 512

data

data object

Job Result

Table 4 data

Parameter

Type

Description

id

String

Job Id

status

String

Job execution status. Running means the job is being executed, Success means the job is successful, Failed means the job is failed.

Enumeration values:

  • Running

  • Success

  • Failed

begin_time

String

Creation time, in the format yyyy-mm-ddThh:mm:ssZ. where T refers to the beginning of a certain time; Z refers to the time zone offset, for example, the Beijing time offset is displayed as +0800.

end_time

String

End time, in the format "yyyy-mm-ddThh:mm:ssZ". where T refers to the beginning of a certain time; Z refers to the time zone offset, for example, the Beijing time offset is displayed as +0800.

Example Requests

Get job status of the job which job id is f588ce71-e26c-400d-8981-f854355f6849 and project id is 09bb24e6fe80d23d2fa2c010b53b418c.

/v3/09bb24e6fe80d23d2fa2c010b53b418c/jobs/f588ce71-e26c-400d-8981-f854355f6849

Example Responses

Status code: 200

Get Job Response

{
  "data" : {
    "begin_time" : 1641370501000,
    "end_time" : 1641370515000,
    "id" : "f588ce71-e26c-400d-8981-f854355f6849",
    "status" : "Success"
  }
}

Status Codes

Status Code

Description

200

Get Job Response

Error Codes

See Error Codes.