查询数据同步任务列表

最近更新时间:2017-12-14 14:48:21

1. 接口描述

本接口(GetCdbDataSyncTaskList)用于查询数据同步任务列表,返回数据同步任务的详细信息。
接口请求域名:cdb.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的Action字段为GetCdbDataSyncTaskList。

参数名称 是否必选 类型 描述
jobId Int 数据同步任务ID,请使用查询数据同步任务列表接口查询任务ID
jobName String 数据同步任务名称
status Array 数据同步任务状态集合,可取值包括:
0-未配置
1-已配置
2-校验中
3-校验失败
4-校验成功
5-准备同步
6-同步中
7-待切换
8-同步失败
9-同步成功
srcUInstanceId String 主实例ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例ID相同,可使用查询实例列表 接口获取,其值为输出参数中字段 uInstanceId 的值。
dstUInstanceId String 灾备实例ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例ID相同,可使用查询实例列表 接口获取,其值为输出参数中字段 uInstanceId 的值。
order String 排序字段,可以取值为jobId、status、jobName、submitTime
orderSeq String 排序方式,升序为ASC,降序为DESC
offset Int 偏移量,默认为0
limit Int 返回实例数量,默认20,有效区间[1,100]
submitTimeStart String 任务提交时间起始点,格式为 yyyy-mm-dd hh:mm:ss
submitTimeEnd String 任务提交时间结束点,格式为 yyyy-mm-dd hh:mm:ss

3. 输出参数

参数名称 类型 描述
code Int 公共错误码, 0表示成功,其他值表示失败。详见错误码页面的公共错误码
message String 模块错误信息描述,与接口相关。
codeDesc String 英文错误描述
data Object 返回的数据
data.totalNum Int 满足查询条件的数据同步任务条数
data.jobList Array 数据同步任务分页列表

其中, jobList 中每一个元素为Object,其构成如下:

参数名称 类型 描述
code Int 数据同步任务执行状态码,0表示成功,其他表示失败
message String 数据同步任务执行状态信息
jobId Int 数据同步任务 ID
type Int 数据同步任务类型,值包括:
10-灾备同步任务
status Int 数据同步任务执行状态,值包括:
0-未配置
1-已配置
2-校验中
3-校验失败
4-校验成功
5-准备同步
6-同步中
7-待切换
8-同步失败
9-同步成功
progress Int 数据同步任务执行进度
startTime String 数据同步任务开始时间,格式为 yyyy-mm-dd hh:mm:ss
EndTime String 数据同步任务结束时间,格式为 yyyy-mm-dd hh:mm:ss
detail Object 数据同步任务的其他详细信息

其中, detail 的构成为:

参数名称 类型 描述
jobName String 数据同步任务名称
runMode Int 任务运行模式,值包括:1-立即执行,2-定时执行
migrateType Int 数据同步类型,值包括:
1-结构同步
2-全量同步
3-全量+增量同步
extMsg String 数据同步任务后台执行的提示信息
srcInfo Object 源实例信息,包含region和cdbUInstanceId
dstInfo Object 目的实例信息,包含region和cdbUInstanceId
jobInput Object 用户停止任务的相关信息
checkInfo Object 校验数据同步任务的相关信息
jobOutput Object 同步任务执行过程的相关信息
expectTime String 同步务期望执行时间,格式为 yyyy-mm-dd hh:mm:ss
updateTime String 同步任务状态更新时间,格式为 yyyy-mm-dd hh:mm:ss
submitTime String 同步任务提交时间,格式为 yyyy-mm-dd hh:mm:ss

其中, jobInput 的构成为:

参数名称 类型 描述
stopStatus Int 数据同步任务中止状态码,100-任务强行停止中,101-任务停止成功,102-任务停止失败
stopMsg String 数据同步任务中止信息

其中, checkInfo 的构成为:

参数名称 类型 描述
checkFlag Int 数据同步任务的校验情况,0-未校验,1-校验通过,2-校验未通过
checkResult Object 数据同步任务校验详情,分步骤展示,具体参见示例

其中, jobOutput 的构成为:

参数名称 类型 描述
code Int 数据同步任务执行的状态码,0表示成功,其他表示失败
message String 数据同步任务执行的错误提示信息
stepAll Int 数据同步任务的执行步骤总数
stepNow Int 数据同步任务当前执行的步骤ID
stepName Int 数据同步任务当前执行的步骤名
stepPercent String 数据同步任务当前执行的百分比
costTime Int 数据同步任务已经执行的时间,单位秒
createTime String 数据同步任务的后台创建时间
stepInfo Object 数据同步任务执行过程的步骤信息,具体参见示例

4. 错误码表

以下错误码表仅列出了该接口的业务逻辑错误码。

错误代码 英文提示 错误描述
9003 InvalidParameter 参数错误
9006 InternalError 数据库内部错误
9013 InternalError 系统内部错误
9016 InternalError 系统内部错误
9544 OperationDenied 实例不存在
9572 InstanceNotExists 实例不存在
9590 InternalFailure 同步任务数据库访问错误
9593 IncorrectInstanceStatus 实例状态异常

5. 示例

输入

https://cdb.api.qcloud.com/v2/index.php?Action=GetCdbDataSyncTaskList
&<公共请求参数>
&offset=0
&limit=1

输出

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "totalCount": 1,
        "jobList": [
            {
                "code": 0,
                "message": "",
                "jobId": 124,
                "type": 10,
                "status": 9,
                "progress": 100,
                "startTime": "2017-02-23 15:04:10",
                "endTime": "2017-02-23 15:06:00",
                "detail": {
                    "jobName": "灾备同步",
                    "runMode": "1",
                    "migrateType": "3",
                    "extMsg": "实例升级成功",
                    "srcInfo": {
                        "regionId": 1,
                        "cdbUInstanceId": "cdb-5u7czxdx",
                        "dbInfo": [],
                        "isOverrideRoot": 1
                    },
                    "dstInfo": {
                        "regionId": 4,
                        "cdbUInstanceId": "cdb-ek0t57qd"
                    },
                    "jobInput": [],
                    "checkInfo": {
                        "checkFlag": 1,
                        "checkResult": {
                            "code": 0,
                            "message": "灾备检查成功",
                            "status": "finished",
                            "isSuccess": 1,
                            "stepInfo": [
                                {
                                    "stepNo": 1,
                                    "stepName": "检查参数",
                                    "code": 0,
                                    "message": "校验成功"
                                },
                                {
                                    "stepNo": 2,
                                    "stepName": "检查源实例",
                                    "code": 0,
                                    "message": "校验成功"
                                },
                                {
                                    "stepNo": 3,
                                    "stepName": "检查目标实例",
                                    "code": 0,
                                    "message": "校验成功"
                                },
                                {
                                    "stepNo": 4,
                                    "stepName": "检查实例状态",
                                    "code": 0,
                                    "message": "校验成功"
                                },
                                {
                                    "stepNo": 5,
                                    "stepName": "检查实例规格",
                                    "code": 0,
                                    "message": "校验成功"
                                },
                                {
                                    "stepNo": 6,
                                    "stepName": "检查实例版本",
                                    "code": 0,
                                    "message": "校验成功"
                                },
                                {
                                    "stepNo": 7,
                                    "stepName": "检查目标实例是否为空",
                                    "code": 0,
                                    "message": "校验成功"
                                },
                                {
                                    "stepNo": 8,
                                    "stepName": "检查实例同步的库表信息",
                                    "code": 0,
                                    "message": "校验成功"
                                },
                                {
                                    "stepNo": 9,
                                    "stepName": "检查实例冷备数据",
                                    "code": 0,
                                    "message": "成功"
                                }
                            ]
                        }
                    },
                    "jobOutput": {
                        "code": 0,
                        "message": "灾备同步成功",
                        "status": "normal_finish",
                        "stepAll": 6,
                        "stepNow": 6,
                        "stepName": "创建冷备",
                        "stepPercent": "100.00",
                        "costTime": 111,
                        "createTime": "2017-02-23 15:04:09",
                        "stepInfo": [
                            {
                                "stepNo": 1,
                                "stepName": "检查环境",
                                "canStop": 0
                            },
                            {
                                "stepNo": 2,
                                "stepName": "迁移配置",
                                "canStop": 0
                            },
                            {
                                "stepNo": 3,
                                "stepName": "导入冷备",
                                "canStop": 1
                            },
                            {
                                "stepNo": 4,
                                "stepName": "建立主从",
                                "canStop": 0
                            },
                            {
                                "stepNo": 5,
                                "stepName": "等待同步",
                                "canStop": 1
                            },
                            {
                                "stepNo": 6,
                                "stepName": "创建冷备",
                                "canStop": 0
                            }
                        ]
                    },
                    "expectTime": "0000-00-00 00:00:00",
                    "updateTime": "2017-02-23 15:06:00",
                    "submitTime": "2017-02-22 22:17:23"
                }
            }
        ]
    }
}