Updated on 2026-09-07 GMT+08:00

Querying the Progress of an Asynchronous Task

This API is used to query the progress of an asynchronous task.

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 and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

GET /v5/{project_id}/jobs/{async_job_id}/progress

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
async_job_id	Yes	String	Definition Unique ID of an asynchronous task. You can obtain this ID from the response by calling the API for exporting creation templates. It is used to query the task execution progress. Constraints N/A Range N/A Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
type	No	String	Definition Type of the asynchronous task to be queried. Constraints The progress of exporting the file list can be queried. Range file Default Value file

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	No	String	Definition MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type. Constraints N/A Range application/json Default Value application/json
X-Auth-Token	Yes	String	Definition User token obtained from IAM. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The token is the value of X-Subject-Token in the response header. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints Specify the request language type based on the supported languages. Range en-us: English zh-cn: Chinese es-us: Spanish pt-br: Portuguese Default Value en-us

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
status	String	Definition Task status. Constraints N/A Range pending failed success
progress	String	Definition Task execution progress. Constraints N/A Range N/A
error_code	String	Definition Error code returned when an error occurs during task execution. Constraints Minimum length: 12 characters Maximum length: 12 characters Range The format is DRS.XXXXXX.
error_message	String	Definition Detailed error description returned when a task fails to be executed. Constraints Minimum length: 1 character Maximum length: 512 characters Range N/A

Querying the progress of an asynchronous task

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/62a055ae-ce03-4232-beb6-46c83b8ef2b2/progress

Status code: 200

{ 
  "status" : "pending" 
}

Status Code	Description
200	OK

For other statuses, see Status Code.

For details, see Error Code.

Parent topic: Task Operations