tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateMigrateCheckJob

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

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.

For a finance zone link, use the domain name https://dts.ap-shenzhen-fsi.tencentcloudapi.com.

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

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

Output Example

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

5. Developer Resources

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.CgwSystemError CGW system error.
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.
InternalError.UndefinedError Internal error.
InternalError.UnknownError Unknown internal error.
InvalidParameter A parameter error occurred.
InvalidParameter.InstanceNotFound The instance does not exist.
LimitExceeded.MaxUnusedJobs The number of idle migration tasks exceeds the limit.
OperationDenied Operation denied.
OperationDenied.JobOperationDeniedError Task operation failure.
ResourceNotFound.JobNotExist The migration task does not exist.
UnauthorizedOperation.NotEnoughPrivileges Verification failed. Insufficient permissions.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy