Help & DocumentationAPIsData Transmission ServiceDTS APIsCreateMigrateCheckJob

CreateMigrateCheckJob

Last updated: 2020-03-16 10:30:50

1. API Description

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

This API is used to create a migration check task.
Before migration, you should call this API to create a check. Migration will start only if the check succeeds. You can view the check result through the DescribeMigrateCheckJob API.
After successful check, if the migration task needs to be modified, a new check task should be created and migration will begin only after the new check succeeds.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: dts.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: CreateMigrateCheckJob.
Version Yes String Common parameter. The value used for this API: 2018-03-30.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
JobId Yes String Data migration task ID

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 Creating a Migration Check Task

Input Example

https://dts.tencentcloudapi.com/?Action=CreateMigrateCheckJob
&JobId=dts-1kl0iy0v
&<Common request parameter>

Output Example

{
  "Response": {
    "RequestId": "46b45da1-3e8e-4ef2-8de8-b1bffa027385"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

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.
InternalError.AddTaskError Failed to create the async task.
InternalError.DatabaseError Failed to access the database on the DTS platform.
InternalError.DuplicateJob Migration tasks are in conflict.
InternalError.LockError Locks are in conflict.
InternalError.ProtocolError Communication protocol error.
InvalidParameter Invalid parameter.
LimitExceeded.MaxUnusedJobs The number of idle migration tasks exceeds the limit.
ResourceNotFound.JobNotExist The migration task does not exist.