1. 接口描述
接口请求域名： msp.tencentcloudapi.com 。
注册迁移任务
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：RegisterMigrationTask。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-19。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| TaskType | 是 | String | 任务类型，取值database（数据库迁移）、file（文件迁移）、host（主机迁移） |
| TaskName | 是 | String | 任务名称 |
| ServiceSupplier | 是 | String | 服务提供商名称 |
| CreateTime | 是 | Timestamp | 迁移任务创建时间 |
| UpdateTime | 是 | Timestamp | 迁移任务更新时间 |
| MigrateClass | 是 | String | 迁移类别，如数据库迁移中mysql:mysql代表从mysql迁移到mysql，文件迁移中oss:cos代表从阿里云oss迁移到腾讯云cos |
| SrcInfo | 否 | SrcInfo | 迁移任务源信息 |
| DstInfo | 否 | DstInfo | 迁移任务目的信息 |
| SrcAccessType | 否 | String | 源实例接入类型，数据库迁移时填写值为：extranet(外网),cvm(cvm自建实例),dcg(专线接入的实例),vpncloud(云vpn接入的实例),vpnselfbuild(自建vpn接入的实例)，cdb(云上cdb实例) |
| SrcDatabaseType | 否 | String | 源实例数据库类型，数据库迁移时填写，取值为mysql,redis,percona,mongodb,postgresql,sqlserver,mariadb 之一 |
| DstAccessType | 否 | String | 目标实例接入类型，数据库迁移时填写值为：extranet(外网),cvm(cvm自建实例),dcg(专线接入的实例),vpncloud(云vpn接入的实例),vpnselfbuild(自建vpn接入的实例)，cdb(云上cdb实例) |
| DstDatabaseType | 否 | String | 目标实例数据库类型,数据库迁移时填写，取值为mysql,redis,percona,mongodb,postgresql,sqlserver,mariadb 之一 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务ID |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 注册迁移任务
注册迁移任务
输入示例
https://msp.tencentcloudapi.com/?Action=RegisterMigrationTask
&TaskType=database
&TaskName=ccc
&ServiceSupplier=TencentCloud
&CreateTime=2018-07-13 15:00:00
&UpdateTime=2018-07-13 15:00:00
&MigrateClass=mysql:mysql
&SrcInfo.Region=ap-beijing
&SrcInfo.Ip=127.0.0.1
&SrcInfo.Port=80
&DstInfo.Region=ap-beijing
&DstInfo.Ip=127.0.0.1
&DstInfo.Port=80
&SrcAccessType=cvm
&SrcDatabaseType=mysql
&DstAccessType=cvm
&DstDatabaseType=mysql
&<公共请求参数>输出示例
{
"Response": {
"TaskId": "msp-jitoh33n",
"RequestId": "be64a8a3-932f-4ea0-91af-843f537c5648"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | 参数取值错误。 |
| ResourceUnavailable | 资源不可用。 |
