查询灾备同步任务校验结果

最近更新时间:2019-03-14 20:22:26

1. 接口描述

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

本接口用于在通过 CreateSyncCheckJob 接口创建灾备同步校验任务后,获取校验的结果。能查询到当前校验的状态和进度。 若通过校验, 则可调用 StartSyncJob 启动同步任务。 若未通过校验, 则会返回校验失败的原因。 可通过 ModifySyncJob 修改配置,然后再次发起校验。 校验任务需要大概约30秒,当返回的 Status 不为 finished 时表示尚未校验完成,需要轮询该接口。 如果 Status=finished 且 CheckFlag=1 时表示校验成功。 如果 Status=finished 且 CheckFlag !=1 时表示校验失败。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSyncCheckJob
Version String 公共参数,本接口取值:2018-03-30
Region String 公共参数,详见产品支持的地域列表
JobId String 要查询的灾备同步任务ID

3. 输出参数

参数名称 类型 描述
Status String 任务校验状态: starting(开始中),running(校验中),finished(校验完成)
ErrorCode Integer 任务校验结果代码
ErrorMessage String 提示信息
StepInfo Array of SyncCheckStepInfo 任务执行步骤描述
CheckFlag Integer 校验标志:0(尚未校验成功) , 1(校验成功)
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询灾备同步任务校验结果

输入示例

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

输出示例

{
    "Response": {
        "Status": "finished",
        "ErrorCode": 0,
        "ErrorMessage": "灾备检查成功",
        "StepInfo": [
            {
                "StepNo": 1,
                "StepName": "检查参数",
                "StepCode": 0,
                "StepMessage": "校验成功"
            },
            {
                "StepNo": 2,
                "StepName": "检查源实例",
                "StepCode": 0,
                "StepMessage": "校验成功"
            },
            {
                "StepNo": 3,
                "StepName": "检查目标实例",
                "StepCode": 0,
                "StepMessage": "校验成功"
            },
            {
                "StepNo": 4,
                "StepName": "检查实例状态",
                "StepCode": 0,
                "StepMessage": "校验成功"
            },
            {
                "StepNo": 5,
                "StepName": "检查实例规格",
                "StepCode": 0,
                "StepMessage": "校验成功"
            },
            {
                "StepNo": 6,
                "StepName": "检查实例版本",
                "StepCode": 0,
                "StepMessage": "校验成功"
            },
            {
                "StepNo": 7,
                "StepName": "检查目标实例是否为空",
                "StepCode": 0,
                "StepMessage": "校验成功"
            },
            {
                "StepNo": 8,
                "StepName": "检查是否开启加密",
                "StepCode": 0,
                "StepMessage": "校验成功"
            },
            {
                "StepNo": 9,
                "StepName": "检查实例同步的库表信息",
                "StepCode": 0,
                "StepMessage": "校验成功"
            },
            {
                "StepNo": 10,
                "StepName": "检查实例冷备数据",
                "StepCode": 0,
                "StepMessage": "校验成功"
            }
        ],
        "CheckFlag": 1,
        "RequestId": "b3951c71-1da4-4b8f-9de5-ad71ab1e2917"
    }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

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