Obtaining Job Details

Function

Obtain job details.

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 /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. Obtain the token. For details, see "Obtaining a User Token" in Identity and Access Management API Reference. The value of X-Subject-Token in the response header is the token value.
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 is set to 0, resources in the default enterprise project are queried. NOTE: For details about how to obtain enterprise project IDs and enterprise project features, see Enterprise Management User Guide.
X-Environment-ID	Yes	String	Environment ID. To obtain an environment ID, see Obtaining the Environment List. In the response, id under items indicates the environment ID.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
api_version	String	API version. Fixed value: v1.
kind	String	API type. Fixed value: Job.
spec	JobSpec object	Job specifications.

**Table 4** JobSpec
Parameter	Type	Description
progress	Number	Job progress.
status	String	Task status. init running failed timeout success skip terminating terminated
tasks	Array of Task objects	Sub-job.

**Table 5** Task
Parameter	Type	Description
index	Integer	Task index.
name	String	Task name.
status	String	Definition Task status. Range init running failed timeout success skip terminating terminated Default Value N/A
detail	String	Task details
created_at	String	Creation time.
updated_at	String	Update time.

Example Requests

Obtain job details.

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

Example Responses

Status code: 200

{
  "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"
    } ]
  }
}