tencent cloud



Last updated: 2022-05-12 10:02:19

1. API Description

Domain name for API request: dts.tencentcloudapi.com.

This API (CompleteMigrateJob) is used to complete a data migration task.
For tasks in incremental migration mode, you need to call this API before migration gets ready, so as to stop migrating incremental data.
If the task status queried through the (DescribeMigrateJobs) API is ready (status=8), you can call this API to complete the migration task.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CompleteMigrateJob.
Version Yes String Common Params. The value used for this API: 2018-03-30.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
JobId Yes String Data migration task ID
CompleteMode No String The way to complete the task, which is supported only for legacy MySQL migration task. waitForSync: wait for the source-replica lag to become 0 before stopping; immediately: complete immediately without waiting for source-replica sync. Default value: waitForSync

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Completing a data migration task

Input Example

&<Common request parameters>

Output Example

  "Response": {
    "RequestId": "5268ea15-6636-44d1-89f9-e989d1c82e7d"

5. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.NotAllowOperation This operation is prohibited.
FailedOperation.StatusInConflict This operation cannot be performed due to status conflict.
InternalError.DatabaseError Failed to access the database on the DTS platform.
InternalError.DuplicateJob Migration tasks are in conflict.
InternalError.ProtocolError Communication protocol error.
InternalError.UnknownError Unknown internal error.
InvalidParameter A parameter error occurred.
OperationDenied.JobOperationDeniedError Task operation failure.
ResourceNotFound.BizResourceNotFoundError Resource not found.
ResourceNotFound.JobNotExist The migration task does not exist.
UnauthorizedOperation.NotEnoughPrivileges Verification failed. Insufficient permissions.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support