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

Submitting Tasks Created Asynchronously in Batches

Function

This API is used to submit the tasks created asynchronously in batches. After tasks are asynchronously created in batches or parameters are updated, the system automatically verifies the parameters. After the parameters of all tasks are verified and no error is reported, you can call this API to create DRS instances.

Constraints

  • This API is available only for 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.

URI

POST /v5/{project_id}/batch-async-jobs/{async_job_id}/commit

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.

async_job_id

Yes

String

ID of the tasks created asynchronously in batches, which is returned by the API for asynchronously creating tasks in batches.

Request Parameters

Table 2 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 3 Response body parameters

Parameter

Type

Description

job

Object

Response body for submitting the tasks created asynchronously in batches with a specified ID.

For details, see Table 4.
Table 4 Data structure description of field job

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.

msg

String

Result of submitting the tasks created asynchronously in batches with a specified ID.

Status code: 400

Table 5 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

Submitting the tasks created asynchronously in batches

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/batch-async-jobs/bd4193aa-072d-4ce6-beec-adffc7252341/commit

Example Response

Status code: 200

OK

{
    "job": {
        "async_job_id": "ac64275d-ae2a-4597-9bb5-a021af3f33e9"
    }
}

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.