一、1. 接口描述
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。你可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
二、2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数，本接口取值：CheckMigrateCluster。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例 ID。可通过 DescribeDBInstances 接口获取。示例值：cdb-2wpip111 |
| Cpu | 否 | Integer | 实例 CPU 核数。当 InstanceId 为主实例时必传。示例值：1 |
| Memory | 否 | Integer | 实例内存大小，单位：MB。当 InstanceId 为主实例时必传。示例值：1000 |
| Volume | 否 | Integer | 实例硬盘大小，单位：GB。示例值：50 |
| DiskType | 否 | String | 磁盘类型。 CLOUD_SSD: SSD 云硬盘; CLOUD_HSSD: 增强型 SSD 云硬盘。示例值：CLOUD_SSD |
| ClusterTopology | 否 | ClusterTopology | 云盘版节点拓扑配置。当 InstanceId 为主实例时必传。示例值：{"ReadWriteNode":{"Zone":"ap-beijing-6"},"ReadOnlyNodes":[{"Zone":"ap-beijing-6"}]} |
| DeviceType | 否 | String | 迁移实例类型。支持值包括： "CLOUD_NATIVE_CLUSTER" – 标准型云盘版实例， "CLOUD_NATIVE_CLUSTER_EXCLUSIVE" – 加强型云盘版实例。示例值：CLOUD_NATIVE_CLUSTER |
| RoInfo.N | 否 | Array of MigrateClusterRoInfo | 只读实例信息。示例值：{"InstanceRole": "ro","MasterInstanceId": "cdb-fn3f9xpx","Period": "1","Volume": 100,"Memory": 4000} |
三、3. 输出参数
| 参数名称 | 类型 | 描述 |
| CheckResult | String | 校验是否通过，通过为pass，失败为fail示例值：pass |
| Items | Array of CheckMigrateResult | 校验项示例值：{"Name": "jiaoyan","Status": "pass","Desc": "pass"} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
四、输入示例
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckMigrateCluster
<公共请求参数>
{
"InstanceId": "cdb-f35wr6wj"
}
五、输出示例
{
"Response": {
"CheckResult": "pass",
"Items": [
{
"Name": "SubVersion",
"Status": "pass"
}
],
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}
六、腾讯云 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: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
九、命令行工具
·Tencent Cloud CLI 3.0
十、6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。