产品动态
公告
Domain name for API request: dts.intl.tencentcloudapi.com.
This API is used to purchase migration tasks. After the tasks are purchased successfully, a randomly generated list of task IDs will be returned. You can also call the DescribeMigrationJobs API to query the IDs of the successfully purchased tasks. Note that once a task is purchased successfully, the types and regions of the source and target databases cannot be changed.
A maximum of 20 requests can be initiated per second for this API.
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: CreateMigrationService. |
| Version | Yes | String | Common Params. The value used for this API: 2021-12-06. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| SrcDatabaseType | Yes | String | Source database type. Valid values: mysql, redis, percona, mongodb, postgresql, sqlserver, mariadb, and cynosdbmysql. |
| DstDatabaseType | Yes | String | Target database type. Valid values: mysql, redis, percona, mongodb ,postgresql, sqlserver, mariadb, and cynosdbmysql. |
| SrcRegion | Yes | String | Source instance region, such as ap-guangzhou. |
| DstRegion | Yes | String | Target instance region, such as ap-guangzhou. Note that it must be the same as the API request region. |
| InstanceClass | Yes | String | Instance specification. Valid values: small, medium, large, xlarge, 2xlarge. |
| Count | No | Integer | Quantity. Value range: [1,15]. Default value: 1. |
| JobName | No | String | Migration task name, which can contain up to 128 characters. |
| Tags.N | No | Array of TagItem | Tag information |
| Parameter Name | Type | Description |
|---|---|---|
| JobIds | Array of String | The list of migration task IDs randomly generated in the format of dts-c1f6rs21 after a successful order placementNote: This field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to purchase a migration task.
POST / HTTP/1.1Host: dts.intl.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: CreateMigrationService<Common request parameters>{ "SrcDatabaseType": "mysql", "DstDatabaseType": "mysql", "InstanceClass": "xlarge", "SrcRegion": "ap-guangzhou", "DstRegion": "ap-guangzhou", "Tags": [ { "TagKey": "testkey", "TagValue": "testvalue" } ]}{
"Response": {
"JobIds": [
"dts-1ewjspuw"
],
"RequestId": "ac300ff0-00f2-11ed-b005-4930e69d89c2"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure.AuthFailureError | Authentication failed. |
| DryRunOperation.DryRunOperationError | DryRun operation, which means an unnecessary DryRun parameter is passed in yet the request will still be successful. |
| FailedOperation.FailedOperationError | The operation failed. |
| InternalError | An internal error occurred. |
| InternalError.InternalErrorError | An internal error occurred. |
| InternalError.UnknownError | An unknown internal error occurred. |
| InvalidParameter.InvalidParameterError | The parameter is invalid. |
| InvalidParameterValue.InvalidParameterValueError | The parameter is invalid. |
| LimitExceeded.LimitExceededError | The quantity exceeds the limit. |
| MissingParameter.MissingParameterError | The parameter is lost. |
| OperationDenied.OperationDeniedError | The operation was denied. |
| RequestLimitExceeded.RequestLimitExceededError | The number of requests exceeds the limit. |
| ResourceInUse.ResourceInUseError | The resource is being used. |
| ResourceInsufficient.ResourceInsufficientError | The resources are insufficient. |
| ResourceNotFound.ResourceNotFoundError | The resource was not found. |
| ResourceUnavailable.ResourceUnavailableError | The resource is unavailable. |
| ResourcesSoldOut.ResourcesSoldOutError | The resources have been sold out. |
| UnauthorizedOperation.UnauthorizedOperationError | The operation is unauthorized. |
| UnknownParameter.UnknownParameterError | The parameter is unknown. |
| UnsupportedOperation.UnsupportedOperationError | The operation is not supported. |
文档反馈