Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Management of Tasks Created Asynchronously in Batches/ Querying the List of Tasks Created Asynchronously in Batches
Updated on 2024-01-30 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

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 synchronization from MySQL to MySQL, migration from Redis to GeminiDB Redis, migration from cluster Redis to GeminiDB Redis, and synchronization from Oracle to GaussDB Distributed.
  • This API can be used only in certain regions. For details, see Endpoints.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

async_job_id

No

String

ID of the tasks created asynchronously in batches.

status

No

String

Status of the tasks created asynchronously in batches.

domain_name

No

String

Tenant name of the tasks created asynchronously in batches.

user_name

No

String

Username of the tasks created asynchronously in batches.

offset

No

Integer

Offset. The records after this offset will be queried.

limit

No

Integer

Maximum number of records that can be returned.

sort_key

No

String

The keyword based on which the returned results are sorted. The default value is create_time.

sort_dir

No

String

Result sorting order. The value can be desc (descending order) or asc (ascending order). The default value is desc.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

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.

The default value is application/json.

X-Auth-Token

Yes

String

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.

After a request is processed, the value of X-Subject-Token in the header is the token value.

X-Language

No

String

Request language type.

Default value: en-us

Enumerated values:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_count

Integer

Total number of tasks in the list, which is irrelevant to pagination.

jobs

Array of objects

Response body of all tasks created asynchronously in batches.

For details, see Table 5.
Table 5 Data structure description of field jobs

Parameter

Type

Description

async_job_id

String

ID of the tasks created asynchronously in batches.

status

String

Status of the tasks created asynchronously in batches. Values:

  • ASYNC_JOB_VALIDATING: The parameters of the tasks created asynchronously in batches are being verified.
  • ASYNC_JOB_VALIDATE_FAILED: The parameters of the tasks created asynchronously in batches fail to be verified.
  • AUTO_PARAM_VALIDATE_SUCCESS: The parameters of the tasks created asynchronously in batches are successfully verified.
  • COMMIT_SUCCESS: The tasks created asynchronously in batches are successfully submitted.

Enumerated values:

  • ASYNC_JOB_VALIDATING
  • ASYNC_JOB_VALIDATE_FAILED
  • AUTO_PARAM_VALIDATE_SUCCESS
  • COMMIT_SUCCESS

domain_name

String

Tenant name of the tasks created asynchronously in batches.

user_name

String

Username of the tasks created asynchronously in batches.

create_time

String

Time when the tasks are asynchronously created in batches.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum length: 12

Maximum length: 12

error_msg

String

Error message.

Minimum length: 1

Maximum length: 512

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

OK

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

Error Code

For details, see Error Code.