Querying Task Statuses in Batches

Function

This API is used to query task statuses in batches by task ID.

Debugging

You can debug the API in API Explorer to support automatic authentication. API Explorer can automatically generate and debug example SDK code.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions and Supported Actions.

URI

POST /v3/{project_id}/jobs/batch-status

**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

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	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 N/A Range en-us: English zh-cn: Chinese Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
jobs	Yes	Array of strings	Definition Task IDs for batch query. This parameter is used to specify one or more tasks to be queried. Constraints N/A Range N/A Default Value N/A
page_req	No	Object	Definition Pagination information. For details, see Table 4.

**Table 4** Data structure description of field **page_req**
Parameter	Mandatory	Type	Description
cur_page	No	Integer	Definition Current page number. It is used to specify which page of data to be returned during pagination query. If you set this parameter to 0, all data items can be obtained. Constraints If per_page is set to 0, cur_page can only be set to 0 or 1. The value cannot exceed the maximum number of pages (Number of pages = Number of transferred job IDs/Number of tasks on each page). Range N/A Default Value 1
per_page	No	Integer	Definition Number of records returned on each page. This parameter is used to control the number of records displayed on each page during pagination query. If you set this parameter to 0, all data items can be obtained. Constraints If this parameter is set to 0, cur_page can only be set to 0 or 1. Range 0–100 Default Value 5

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
results	Array of objects	Definition Task status information For details, see Table 6.
count	Integer	Definition Number of returned tasks. Constraints N/A Range N/A

**Table 6** Data structure description of field **results**
Parameter	Type	Description
id	String	Definition Task ID, which is used to identify the task corresponding to the query result.
status	String	Definition Task status. Constraints N/A Range CREATING: The task is being created. CREATE_FAILED: The task fails to be created. CONFIGURATION: The task is being configured. STARTJOBING: The task is being started. WAITING_FOR_START: The task is waiting to be started. START_JOB_FAILED: The task fails to be started. PAUSING: The task is paused. FULL_TRANSFER_STARTED: Full migration or synchronization starts. Initialization is in progress in the DR scenario. FULL_TRANSFER_FAILED: Full migration or synchronization fails. Initialization fails in the DR scenario. FULL_TRANSFER_COMPLETE: Full migration or synchronization is complete. Initialization is complete in the DR scenario. INCRE_TRANSFER_STARTED: Incremental migration or synchronization starts. The DR task is in progress. INCRE_TRANSFER_FAILED: Incremental migration or synchronization fails. A DR exception occurs. RELEASE_RESOURCE_STARTED: The task is being stopped. RELEASE_RESOURCE_FAILED: The task fails to be stopped. RELEASE_RESOURCE_COMPLETE: The task is stopped. REBUILD_NODE_STARTED: The task is being recovered. REBUILD_NODE_FAILED: The task fails to be recovered. CHANGE_JOB_STARTED: The task is being changed. CHANGE_JOB_FAILED: The task fails to be changed. DELETED: The task is deleted. CHILD_TRANSFER_STARTING: The subtask is being started. CHILD_TRANSFER_STARTED: The subtask is being migrated. CHILD_TRANSFER_COMPLETE: The subtask migration is complete. CHILD_TRANSFER_FAILED: The subtask fails to be migrated. RELEASE_CHILD_TRANSFER_STARTED: The subtask is being stopped. RELEASE_CHILD_TRANSFER_COMPLETE: The subtask is stopped. NODE_UPGRADE_START: The upgrade starts. NODE_UPGRADE_COMPLETE: The upgrade is complete. NODE_UPGRADE_FAILED: The upgrade fails.
error_code	String	Definition Error code returned if the task fails. Constraints N/A Range The value is in the format of DRS.XXXXXX.
error_message	String	Definition Error message returned if the task fails. Constraints N/A Range N/A

Example Request

Example of querying task statuses in batches:

https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-status

{
  "jobs" : [ "9a470239-2308-4bb5-a6bc-1040402fjb21", "dc67695a-ee3e-49b8-a022-a099bd81jb21" ],
  "page_req" : {
    "cur_page" : 1,
    "per_page" : 10
  }
}

Example Response

Status code: 200

{
  "results" : [ {
    "id" : "9a470239-2308-4bb5-a6bc-1040402fjb21",
    "status" : "INCRE_TRANSFER_STARTED"
  }, {
    "id" : "dc67695a-ee3e-49b8-a022-a099bd81jb21",
    "status" : "INCRE_TRANSFER_FAILED"
  } ],
  "count" : 2
}

Status Code

Status Code	Description
200	OK
400	Bad Request

For other statuses, see Status Code.

Error Code

For details, see Error Code.

Parent topic: Public API Management

Previous topic: Querying Task Details in Batches

Next topic: Configuring Exception Notifications