文档平台 API 中心 数据传输服务 DTS 数据传输服务相关接口 查询在迁移平台发起的灾备同步任务

查询在迁移平台发起的灾备同步任务

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

1. 接口描述

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

查询在迁移平台发起的灾备同步任务

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSyncJobs
Version String 公共参数,本接口取值:2018-03-30
Region String 公共参数,详见产品支持的地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-guangzhou-open, ap-hongkong, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, eu-frankfurt, na-siliconvalley, na-toronto
JobId String 灾备同步任务ID
JobName String 灾备同步任务名
Order String 排序字段,可以取值为JobId、Status、JobName、CreateTime
OrderSeq String 排序方式,升序为ASC,降序为DESC
Offset Integer 偏移量,默认为0
Limit Integer 返回实例数量,默认20,有效区间[1,100]

3. 输出参数

参数名称 类型 描述
TotalCount Integer 任务数目
JobList Array of SyncJobInfo 任务详情数组
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

示例1 查询灾备同步任务

输入示例

https://dts.tencentcloudapi.com/?Action=DescribeSyncJobs
&Order=CreateTime
&OrderSeq=DESC
&Offset=0
&Limit=2
&<公共请求参数>

输出示例

{
  "Response": {
    "JobList": [
      {
        "CreateTime": "2018-06-22 21:59:16",
        "DatabaseInfo": "Array",
        "Detail": {
          "CurrentStepProgress": "",
          "MasterSlaveDistance": 0,
          "Progress": "0",
          "SecondsBehindMaster": 0,
          "StepAll": 0,
          "StepInfo": [],
          "StepNow": 0
        },
        "DstAccessType": "cdb",
        "DstDatabaseType": "mysql",
        "DstInfo": {
          "InstanceId": "cdb-mdgezf4d",
          "Region": "ap-shanghai"
        },
        "EndTime": "0000-00-00 00:00:00",
        "JobId": "sync-blj8wnt1",
        "JobName": "okJobName1",
        "SrcAccessType": "cdb",
        "SrcDatabaseType": "mysql",
        "SrcInfo": {
          "InstanceId": "cdb-e28hhsjt",
          "Region": "ap-shanghai"
        },
        "StartTime": "0000-00-00 00:00:00",
        "Status": 4,
        "SyncOption": {
          "ConsistencyType": 1,
          "RunMode": 1,
          "SyncObject": 1,
          "SyncType": 3
        }
      },
      {
        "CreateTime": "2018-06-22 20:37:28",
        "DatabaseInfo": "Array",
        "Detail": {
          "CurrentStepProgress": "",
          "MasterSlaveDistance": 0,
          "Progress": "",
          "SecondsBehindMaster": 0,
          "StepAll": 0,
          "StepInfo": [],
          "StepNow": 0
        },
        "DstAccessType": "cdb",
        "DstDatabaseType": "mysql",
        "DstInfo": {
          "InstanceId": "cdb-ddlroj4d",
          "Region": "ap-shanghai"
        },
        "EndTime": "0000-00-00 00:00:00",
        "JobId": "sync-2hoficf5",
        "JobName": "test_create_sync_jobName_0622_2100",
        "SrcAccessType": "cdb",
        "SrcDatabaseType": "mysql",
        "SrcInfo": {
          "InstanceId": "cdb-6ygku747",
          "Region": "ap-guangzhou"
        },
        "StartTime": "0000-00-00 00:00:00",
        "Status": 1,
        "SyncOption": {
          "ConsistencyType": 1,
          "RunMode": 1,
          "SyncObject": 2,
          "SyncType": 3
        }
      }
    ],
    "RequestId": "1ae80092-45be-4cf2-b313-026b6380463e",
    "TotalCount": 2
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

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