API 文档

有奖调研

查询实例DTS信息

最近更新时间:2021-10-21 11:34:09

我的收藏

1. 接口描述

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

查询实例DTS信息

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstanceDTSInfo。
Version String 公共参数,本接口取值:2018-04-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID

3. 输出参数

参数名称 类型 描述
JobId String DTS任务ID
注意:此字段可能返回 null,表示取不到有效值。
JobName String DTS任务名称
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 任务状态,取值为:1-创建中(Creating),3-校验中(Checking)4-校验通过(CheckPass),5-校验不通过(CheckNotPass),7-任务运行(Running),8-准备完成(ReadyComplete),9-任务成功(Success),10-任务失败(Failed),11-撤销中(Stopping),12-完成中(Completing)
注意:此字段可能返回 null,表示取不到有效值。
StatusDesc String 状态描述
注意:此字段可能返回 null,表示取不到有效值。
Offset Integer 同步时延,单位:字节
注意:此字段可能返回 null,表示取不到有效值。
CutDownTime String 断开时间
注意:此字段可能返回 null,表示取不到有效值。
SrcInfo DescribeInstanceDTSInstanceInfo 源实例信息
注意:此字段可能返回 null,表示取不到有效值。
DstInfo DescribeInstanceDTSInstanceInfo 目标实例信息
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

https://redis.tencentcloudapi.com/?Action=DescribeInstanceDTSInfo
&InstanceId=crs-6ia1c1c3
&<公共请求参数>

输出示例

{
  "Response": {
    "CutDownTime": "2019-08-16 17:10:13",
    "DstInfo": {
      "InstanceId": "crs-jufvqtt7",
      "InstanceName": "dtsdsttest28",
      "RegionId": 1,
      "SetId": 15005,
      "Status": 1,
      "Type": 2,
      "Vip": "172.16.16.48",
      "ZoneId": 100002
    },
    "JobId": "dts-l2g434lt",
    "JobName": "redis_dts_test28",
    "Offset": 0,
    "RequestId": "f5ff1c8e-7ea4-40a8-b179-8a99c6f7085b",
    "SrcInfo": {
      "InstanceId": "crs-6ia1c1c3",
      "InstanceName": "dtsSrctest28",
      "RegionId": 1,
      "SetId": 15005,
      "Status": -4,
      "Type": 2,
      "Vip": "172.16.16.9",
      "ZoneId": 100002
    },
    "Status": 10,
    "StatusDesc": "已失败"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.SystemError 内部系统错误,和业务无关。
UnauthorizedOperation.NoCAMAuthed 无cam 权限。
目录