Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ Task Management/ Querying Image Task Details
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Querying Image Task Details

Function

Queries the execution status of an asynchronous task, such as an image instance creation task.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

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, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:images:getImageJob

    Read

    -

    -

    -

    -

URI

GET /v1/{project_id}/image-server-jobs/{job_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique ID of a project

job_id

Yes

String

Job ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

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 the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

Job ID.

job_type

String

Task type.

begin_time

String

Task creation time.

end_time

String

Job end time.

status

String

Task status.

WAITING: waiting for execution

RUNNING: running

SUCCESS: completed

FAILED: failed

sub_jobs_total

Integer

Total number of subtasks.

sub_jobs

Array of ImageJobDetailInfo objects

Subtasks.
Table 4 ImageJobDetailInfo

Parameter

Type

Description

id

String

Subtask ID.

job_type

String

Task type.

  • CREATE_SERVER: creating an image instance

  • CREATE_SERVER_IMAGE: creating an image

  • DELETE_SERVER: deleting an image instance

job_resource_info

ImageJobResourceInfo object

Resource information corresponding to the task result, which varies with the task type.

  • Image instance information

  • Image information

begin_time

String

Task creation time.

end_time

String

Job end time.

status

String

Task status:

WAITING: waiting for execution

RUNNING: running

SUCCESS: successful

FAILED: failed

ABNORMAL: abnormal

ROLLBACK: rolling back

ABORTING: being terminated

job_execute_info

ImageJobExecuteInfo object

Task execution failure information.

project_id

String

Project ID.

job_id

String

Job ID.
Table 5 ImageJobResourceInfo

Parameter

Type

Description

resource_id

String

Resource ID.

resource_name

String

Product name or operated resource name.
Table 6 ImageJobExecuteInfo

Parameter

Type

Description

error_code

String

Error code of a failed task.

error_message

String

Task failure cause.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 405

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 500

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 503

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

GET v1/a4da8115c9d8464ead3a38309130523f/image-server-jobs/702364883651395584

Example Responses

Status code: 200

Response to a successful request.

{
  "id" : "702364883651395584",
  "job_type" : "CREATE_SERVER_IMAGE",
  "begin_time" : "2024-05-20T10:39:49.61Z",
  "end_time" : "2024-05-20T11:03:24.206Z",
  "status" : "SUCCESS",
  "sub_jobs_total" : 1,
  "sub_jobs" : [ {
    "id" : "702364884037271552",
    "job_type" : "CREATE_SERVER_IMAGE",
    "job_resource_info" : {
      "resource_id" : "f5d443de-a623-4950-a74d-569fe63c1f7a",
      "resource_name" : "123"
    },
    "begin_time" : "2024-05-20T10:39:50.723Z",
    "end_time" : "2024-05-20T11:03:24.194Z",
    "status" : "SUCCESS",
    "job_execute_info" : {
      "error_code" : "",
      "error_message" : ""
    },
    "project_id" : "a4da8115c9d8464ead3a38309130523f",
    "job_id" : "702364883651395584"
  } ]
}

Status Codes

Status Code

Description

200

Response to a successful request.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

Permissions required.

404

No resources found.

405

The request method is not allowed.

500

An internal service error occurred. For details, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: Task Management