tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

StartMigrateJob

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

1. API Description

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

This API (StartMigrationJob) is used to start a migration task. After the API is called, non-scheduled migration tasks will start the migration immediately, while scheduled tasks will start the countdown.
Before calling this API, be sure to use the CreateMigrateCheckJob API to check the data migration task, which can be started only if its status queried through the DescribeMigrateJobs API is check succeeded (status=4).

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: StartMigrateJob.
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 Starting a migration task

Input Example

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

Output Example

{
  "Response": {
    "RequestId": "bab78b9b-ce8a-4645-bfb2-5b03397d6ea0"
  }
}

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.
FailedOperation.StartJobFailed Failed to start the task.
FailedOperation.StatusInConflict This operation cannot be performed due to status conflict.
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.
InternalError.UnknownError Unknown internal error.
InvalidParameter A parameter error occurred.
LimitExceeded.MaxUnusedJobs The number of idle migration tasks exceeds the limit.
OperationDenied.BizOperationDeniedError The operation was denied as the condition was not met.
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