获取迁移校验结果

最近更新时间:2018-09-18 17:00:18

1. 接口描述

接口请求域名: dts.tencentcloudapi.com 。

本接口用于创建校验后,获取校验的结果. 能查询到当前校验的状态和进度. 若通过校验, 则可调用'StartMigrateJob' 开始迁移. 若未通过校验, 则能查询到校验失败的原因. 请按照报错, 通过'ModifyMigrateJob'修改迁移配置或是调整源/目标实例的相关参数.

默认接口请求频率限制:20次/每秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi )时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:dts.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMigrateCheckJob
Version String 公共参数,本接口取值:2018-03-30
Region String 公共参数,详见产品支持的地域列表
JobId String 数据迁移任务ID

3. 输出参数

参数名称 类型 描述
Status String 校验任务状态:unavailable(当前不可用), starting(开始中),running(校验中),finished(校验完成)
ErrorCode Integer 任务的错误码
ErrorMessage String 任务的错误信息
Progress String Check任务总进度,如:"30"表示30%
CheckFlag Integer 校验是否通过,0-未通过,1-校验通过, 3-未校验
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

示例1 获取迁移校验结果

输入示例

https://dts.tencentcloudapi.com/?Action=DescribeMigrateCheckJob
&JobId=dts-1kl0iy0v
&<公共请求参数>

输出示例

{
  "Response": {
    "CheckFlag": 0,
    "ErrorCode": -1,
    "ErrorMessage": "选择的库表不存在,请重新选择[存在输入参数table在源实例没有找到]",
    "Progress": "100",
    "RequestId": "67b4cfcf-6957-48ae-b7ef-ba33209895e3",
    "Status": "finished"
  }
}

示例2 获取迁移校验结果

输入示例

https://dts.tencentcloudapi.com/?Action=DescribeMigrateCheckJob
&JobId=dts-dau5czmd
&<公共请求参数>

输出示例

{
  "Response": {
    "CheckFlag": 1,
    "ErrorCode": 0,
    "ErrorMessage": "ok",
    "Progress": "100",
    "RequestId": "336448b0-2a45-4be4-8356-c245eab5784f",
    "Status": "finished"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、 SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集( SDK ),支持多种编程语言,能更方便的调用 API 。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
FailedOperation.NotAllowOperation 禁止该操作。
InternalError.DatabaseError 迁移平台数据库访问失败。
InternalError.ProtocolError 通信协议错误。
InvalidParameter 参数错误
ResourceNotFound.JobNotExist 迁移任务不存在。