1. 接口描述
接口请求域名: dts.tencentcloudapi.com 。
购买迁移任务。购买成功后会返回随机生成的迁移任务id列表,也可以通过查询迁移任务任务列表接口DescribeMigrationJobs
看到购买成功的实例Id。注意,一旦购买成功后源及目标数据库类型,源及目标实例地域不可修改。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateMigrationService。 |
Version | 是 | String | 公共参数,本接口取值:2021-12-06。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
SrcDatabaseType | 是 | String | 源实例数据库类型,如mysql,redis,percona,mongodb,postgresql,sqlserver,mariadb,cynosdbmysql 示例值:mysql |
DstDatabaseType | 是 | String | 目标实例数据库类型,如mysql,redis,percona,mongodb,postgresql,sqlserver,mariadb,cynosdbmysql 示例值:mysql |
SrcRegion | 是 | String | 源实例地域,如:ap-guangzhou 示例值:ap-guangzhou |
DstRegion | 是 | String | 目标实例地域,如:ap-guangzhou。注意,目标地域必须和API请求地域保持一致。 示例值:ap-guangzhou |
InstanceClass | 是 | String | 实例规格,包括:small、medium、large、xlarge、2xlarge 示例值:large |
Count | 否 | Integer | 购买数量,范围为[1,15],默认为1 示例值:1 |
JobName | 否 | String | 迁移服务名称,最大长度128 示例值:migrate_test |
Tags.N | 否 | Array of TagItem | 标签信息 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
JobIds | Array of String | 下单成功随机生成的迁移任务id列表,形如:dts-c1f6rs21 注意:此字段可能返回 null,表示取不到有效值。 示例值:["dts-amm1jw5q"] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 购买迁移任务
购买迁移任务
输入示例
POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateMigrationService
<公共请求参数>
{
"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"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.AuthFailureError | 认证失败。 |
DryRunOperation.DryRunOperationError | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation.FailedOperationError | 操作失败。 |
InternalError | 内部错误。 |
InternalError.InternalErrorError | 内部错误。 |
InternalError.UnknownError | 未知的内部错误。 |
InvalidParameter.InvalidParameterError | 参数无效。 |
InvalidParameterValue.InvalidParameterValueError | 非法参数。 |
LimitExceeded.LimitExceededError | 数量超出限制。 |
MissingParameter.MissingParameterError | 参数丢失。 |
OperationDenied.OperationDeniedError | 操作被拒绝。 |
RequestLimitExceeded.RequestLimitExceededError | 请求次数超限。 |
ResourceInUse.ResourceInUseError | 资源在使用中。 |
ResourceInsufficient.ResourceInsufficientError | 资源短缺。 |
ResourceNotFound.ResourceNotFoundError | 资源未找到。 |
ResourceUnavailable.ResourceUnavailableError | 资源不可用。 |
ResourcesSoldOut.ResourcesSoldOutError | 资源售罄。 |
UnauthorizedOperation.UnauthorizedOperationError | 未授权的操作。 |
UnknownParameter.UnknownParameterError | 未知参数。 |
UnsupportedOperation.UnsupportedOperationError | 不支持的操作。 |