1. 接口描述
接口请求域名： dts.tencentcloudapi.com 。
本接口用于创建校验后,获取校验的结果. 能查询到当前校验的状态和进度.
若通过校验, 则可调用'StartMigrateJob' 开始迁移.
若未通过校验, 则能查询到校验失败的原因. 请按照报错, 通过'ModifyMigrateJob'修改迁移配置或是调整源/目标实例的相关参数.
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeMigrateCheckJob。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-30。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| JobId | 是 | String | 数据迁移任务ID 示例值：dts-1kl0iy0v |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 校验任务状态：unavailable(当前不可用), starting(开始中)，running(校验中)，finished(校验完成) 示例值：finished |
| ErrorCode | Integer | 任务的错误码 示例值：-1 |
| ErrorMessage | String | 任务的错误信息 示例值：选择的库表不存在，请重新选择[存在输入参数table在源实例没有找到] |
| Progress | String | Check任务总进度,如："30"表示30% 示例值：100 |
| CheckFlag | Integer | 校验是否通过,0-未通过，1-校验通过, 3-未校验 示例值：0 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取迁移校验结果
校验成功
输入示例
https://dts.tencentcloudapi.com/?Action=DescribeMigrateCheckJob
&JobId=dts-dau5czmd
&<公共请求参数>输出示例
{
"Response": {
"Status": "finished",
"ErrorCode": 0,
"ErrorMessage": "ok",
"Progress": "100",
"CheckFlag": 1,
"RequestId": "336448b0-2a45-4be4-8356-c245eab5784f"
}
}示例2 获取迁移校验结果-2
校验失败
输入示例
https://dts.tencentcloudapi.com/?Action=DescribeMigrateCheckJob
&JobId=dts-1kl0iy0v
&<公共请求参数>输出示例
{
"Response": {
"Status": "finished",
"ErrorCode": -1,
"ErrorMessage": "选择的库表不存在，请重新选择[存在输入参数table在源实例没有找到]",
"Progress": "100",
"CheckFlag": 0,
"RequestId": "67b4cfcf-6957-48ae-b7ef-ba33209895e3"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.NotAllowOperation | 禁止该操作。 |
| InternalError.DatabaseError | 迁移平台数据库访问失败。 |
| InternalError.ProtocolError | 通信协议错误。 |
| InvalidParameter | 参数错误。 |
| ResourceNotFound.JobNotExist | 迁移任务不存在。 |
| UnauthorizedOperation.NotEnoughPrivileges | 认证失败，没有足够权限。 |
