Querying the List of Tasks Created Asynchronously in Batches

Function

This API is used to query the list of tasks created asynchronously in batches.

Constraints

This API is available only for migration and synchronization from MySQL to MySQL, migration from Redis to GeminiDB Redis, migration from Redis Cluster to GeminiDB Redis, and synchronization from Oracle to GaussDB Distributed.
This API can be used only in certain regions. For details, see Endpoints.

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

URI

GET /v5/{project_id}/batch-async-jobs

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

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
async_job_id	No	String	Definition ID of the task created asynchronously in batches. It is used to filter query results by task ID. Constraints N/A Range N/A Default Value N/A
status	No	String	Definition Status of the task created asynchronously in batches. It is used to filter query results by task status. Constraints N/A Range N/A Default Value N/A
domain_name	No	String	Definition Tenant name of the task created asynchronously in batches. It is used to filter query results by tenant name. Constraints N/A Range N/A Default Value N/A
user_name	No	String	Definition Username of the task created asynchronously in batches. It is used to filter query results by username. Constraints N/A Range N/A Default Value N/A
offset	No	Integer	Definition Offset, which is used for pagination query. The records after this offset will be queried. Constraints N/A Range N/A Default Value N/A
limit	No	Integer	Definition Maximum number of records that can be returned. This parameter is used to specify the number of records returned on each page during pagination query. Constraints N/A Range N/A Default Value N/A
sort_key	No	String	Definition Keyword for sorting the returned results. This parameter specifies the sorting basis of the task list. Constraints N/A Range create_time: sorting by creation time Default Value N/A
sort_dir	No	String	Definition Sorting order, which specifies whether the returned results are sorted in ascending or descending order. Constraints N/A Range desc: descending order asc: ascending order Default Value desc

Request Parameters

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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_count	Integer	Definition Total number of records in the list, which is irrelevant to pagination. Constraints N/A Range N/A
jobs	Array of objects	Definition Response list of the tasks created asynchronously in batches, which contains information about all asynchronous tasks that meet the search criteria. For details, see Table 5.

**Table 5** Data structure description of field **jobs**
Parameter	Type	Description
async_job_id	String	Definition ID of the task created asynchronously in batches, which uniquely identifies the task. Constraints N/A Range N/A
status	String	Definition Status of the task created asynchronously in batches, which indicates the current execution phase of the task. Constraints N/A Range ASYNC_JOB_VALIDATING: The parameters of the task are being verified. ASYNC_JOB_VALIDATE_FAILED: The parameters of the task failed to be verified. AUTO_PARAM_VALIDATE_SUCCESS: The parameters of the task are successfully verified. COMMIT_SUCCESS: The task is successfully submitted.
domain_name	String	Definition Tenant name of the task created asynchronously in batches, which identifies the tenant (domain name) to which the task belongs. Constraints N/A Range N/A
user_name	String	Definition Username of the task created asynchronously in batches, which identifies the IAM user who created the task. Constraints N/A Range N/A
create_time	String	Definition Time when the task was created asynchronously in batches, which indicates the timestamp when the task was created for the first time. Constraints N/A Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
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_msg	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

Example Request

Querying the list of tasks created asynchronously in batches

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/batch-async-jobs?async_job_id=&status=&domain_name=&user_name=&offset=0&limit=10&sort_key=&sort_dir=

Example Response

Status code: 200

{
  "jobs" : [ {
    "async_job_id" : "bd4193aa-072d-4ce6-beec-adffc7252341",
    "status" : "AUTO_PARAM_VALIDATE_SUCCESS",
    "domain_name" : "domain_name1",
    "user_name" : "user_name1",
    "create_time" : "2022-11-07T06:41:08Z"
  }, {
    "async_job_id" : "7b65d750-51e5-4647-a088-663d28152a3d",
    "status" : "COMMIT_SUCCESS",
    "domain_name" : "domain_name2",
    "user_name" : "user_name2",
    "create_time" : "2022-11-05T16:03:45Z"
  } ],
  "total_count" : 2
}

Status code: 400

Bad Request

{
  "error_code" : "DRS.10000001",
  "error_msg" : "Failed."
}

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: Management of Tasks Created Asynchronously in Batches

Previous topic: Submitting Tasks Created Asynchronously in Batches

Next topic: Querying Details About Tasks Created Asynchronously in Batches with a Specified ID