Help Center/ Cloud Application Engine/ API Reference/ CAE API/ Job/ Obtaining the Details of a Job
Updated on 2025-02-14 GMT+08:00

Obtaining the Details of a Job

Function

This API is used to obtain the details of a job.

URI

GET /v1/{project_id}/cae/jobs/{job_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. See Obtaining a 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.

Maximum characters: 16,384

X-Enterprise-Project-ID

No

String

Enterprise project ID.

  • When an environment is created, it will be bound with an enterprise project ID.
  • Enter 0 or up to 36 characters in UUID format with hyphens (-).
  • If this parameter is not specified or set to 0, resources in the default enterprise project are queried.
NOTE:

For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

X-Environment-ID

Yes

String

Environment ID.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

api_version

String

API version. Fixed value: v1.

Enumerated value:

  • v1

kind

String

API type. Fixed value: Job.

Enumerated value:

  • Job

spec

JobSpec object

Job specifications.

Table 4 JobSpec

Parameter

Type

Description

progress

Number

Job progress.

status

String

Job status.

tasks

Array of Task objects

Task.

Table 5 Task

Parameter

Type

Description

index

Integer

Task index.

name

String

Task name.

status

String

Task status.

detail

String

Task details.

created_at

String

Creation time.

updated_at

String

Update time.

Example Request

Obtain the details of a job.

GET https://{endpoint}/v1/{project_id}/cae/jobs/{job_id}

Example Response

Status code: 200

The request is successful.

{
  "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 Code

Status Code

Description

200

The request is successful.

Error Code

For details, see Error Codes.