文档首页/ 数据复制服务 DRS/ API参考/ API v5（公测中）/ 资源管理/ 查询可用链路信息 - ListSupportLinks
更新时间：2026-07-29 GMT+08:00
查看PDF
分享

查询可用链路信息 - ListSupportLinks

功能介绍

根据参数不同，可查询实时迁移、实时同步、实时灾备等可用链路信息。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/support-links

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的Project ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

job_type

是

String

参数解释：

DRS任务场景类型，用于区分不同的数据复制场景。

约束限制：

不涉及。

取值范围：

  • migration：实时迁移。

  • sync：实时同步。

  • cloudDataGuard：实时灾备。

  • replay：录制回放。

  • verify：校验任务。

默认取值：

不涉及。

offset

否

Integer

参数解释：

偏移量，表示查询该偏移量后面的记录，用于分页查询。

约束限制：

最大为10000。

取值范围：

不涉及。

默认取值：

0

limit

否

Integer

参数解释：

查询返回记录的数量限制，用于分页查询时控制每页返回的数据条数。

约束限制：

最大为2000。

取值范围：

不涉及。

默认取值：

10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

参数解释：

发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。

约束限制：

不涉及。

取值范围：

application/json

默认取值：

application/json

X-Auth-Token

是

String

参数解释：

从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us：英语
  • zh-cn：中文

默认取值：

en-us

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of objects

参数解释：

查询可用链路信息响应体。

详情请参见SupportLinksResp。
表5 SupportLinksResp

参数

参数类型

描述

total_count

Integer

参数解释：

列表中的项目总数，与分页无关。表示满足查询条件的记录总数量，用于分页计算。

约束限制：

不涉及。

取值范围：

不涉及。

support_links

Array of objects

参数解释：

DRS支持的数据复制链路列表，每条链路包含引擎类型、网络类型、迁移模式等组合信息。

详情请参见SupportLinkInfo。
表6 SupportLinkInfo

参数

参数类型

描述

engine_type

String

参数解释：

DRS任务引擎类型，标识数据复制任务所使用的数据库引擎。

约束限制：

不涉及。

取值范围：

不涉及。

net_type

String

参数解释：

任务使用的网络类型。

约束限制：

灾备场景不支持选择VPC网络。

取值范围：

  • eip：公网网络。

  • vpc：VPC网络，灾备场景不支持选择VPC网络。

  • vpn：VPN、专线网络。

task_modes

Array of strings

参数解释：

可用链路支持的迁移模式列表，表示该链路支持的数据迁移执行方式。

约束限制：

不涉及。

取值范围：

不涉及。

  • FULL_TRANS ：全量迁移。

  • FULL_INCR_TRANS：全量+增量迁移。

  • INCR_TRANS：增量迁移。

job_direction

String

参数解释：

任务的迁移方向。

约束限制：

不涉及。

取值范围：

  • up：入云 ，灾备场景时对应本云为备。

  • down：出云，灾备场景时对应本云为主。

  • non-dbs：自建。

cluster_mode

String

参数解释：

云上数据库实例部署模式，标识目标或源数据库实例在云上的集群架构类型。

约束限制：

不涉及。

取值范围：

  • Single：单机模式。

  • Ha：主备模式。

  • Cluster：集群模式。

  • Sharding：分片模式。

  • Independent：GaussDB独立部署模式。

  • Replica：RDS只读副本。
  • ReplicaSet：MongoDB副本集。

job_instance_type

String

参数解释：

DRS迁移实例的部署类型。

约束限制：

不涉及。

取值范围：

  • Single ：单机。

  • Ha：主备。

is_support_bind_eip

Boolean

参数解释：

是否支持绑定绑定弹性公网IP（EIP），标识当前链路是否允许为迁移实例绑定弹性公网IP以实现公网通信。

约束限制：

不涉及。

取值范围：

  • true：支持绑定EIP。
  • false：不支持绑定EIP。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码，当任务报错时返回的错误代码。

约束限制：

  • 最小长度：12
  • 最大长度：12

取值范围：

格式为DRS.XXXXXX。

error_msg

String

参数解释：

错误详细信息，当任务执行失败时返回的具体错误描述。

约束限制：

  • 最小长度：1
  • 最大长度：512

取值范围：

不涉及。

请求示例

  • 查询实时迁移可用链路信息。

    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/support-links?job_type=migration

  • 查询实时同步可用链路信息。

    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/support-links?job_type=sync

  • 查询实时灾备可用链路信息。

    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/support-links?job_type=cloudDataGuard

响应示例

状态码：200

OK

{
  "support_links" : [ {
    "engine_type" : "mysql",
    "net_type" : "eip",
    "task_modes" : [ "FULL_INCR_TRANS", "INCR_TRANS" ],
    "job_direction" : "up",
    "cluster_mode" : "Ha",
    "is_support_bind_eip" : false
  }, {
    "engine_type" : "mysql",
    "net_type" : "eip",
    "task_modes" : [ "FULL_INCR_TRANS", "INCR_TRANS" ],
    "job_direction" : "up",
    "cluster_mode" : "Single",
    "is_support_bind_eip" : false
  }, {
    "engine_type" : "mysql",
    "net_type" : "eip",
    "task_modes" : [ "FULL_INCR_TRANS", "INCR_TRANS" ],
    "job_direction" : "up",
    "cluster_mode" : "Cluster",
    "is_support_bind_eip" : false
  }, {
    "engine_type" : "mysql",
    "net_type" : "vpc",
    "task_modes" : [ "FULL_INCR_TRANS", "INCR_TRANS" ],
    "job_direction" : "up",
    "cluster_mode" : "Ha",
    "is_support_bind_eip" : false
  }, {
    "engine_type" : "mysql",
    "net_type" : "vpc",
    "task_modes" : [ "FULL_INCR_TRANS", "INCR_TRANS" ],
    "job_direction" : "up",
    "cluster_mode" : "Single",
    "is_support_bind_eip" : false
  }, {
    "engine_type" : "mysql",
    "net_type" : "vpc",
    "task_modes" : [ "FULL_INCR_TRANS", "INCR_TRANS" ],
    "job_direction" : "up",
    "cluster_mode" : "Cluster",
    "is_support_bind_eip" : false
  }, {
    "engine_type" : "mysql",
    "net_type" : "vpn",
    "task_modes" : [ "FULL_INCR_TRANS", "INCR_TRANS" ],
    "job_direction" : "up",
    "cluster_mode" : "Ha",
    "is_support_bind_eip" : false
  }, {
    "engine_type" : "mysql",
    "net_type" : "vpn",
    "task_modes" : [ "FULL_INCR_TRANS", "INCR_TRANS" ],
    "job_direction" : "up",
    "cluster_mode" : "Single",
    "is_support_bind_eip" : false
  }, {
    "engine_type" : "mysql",
    "net_type" : "vpn",
    "task_modes" : [ "FULL_INCR_TRANS", "INCR_TRANS" ],
    "job_direction" : "up",
    "cluster_mode" : "Cluster",
    "is_support_bind_eip" : false
  }, {
    "engine_type" : "mongodb",
    "net_type" : "vpc",
    "task_modes" : [ "INCR_TRANS" ],
    "job_direction" : "down",
    "cluster_mode" : "Sharding",
    "is_support_bind_eip" : false
  } ],
  "total_count" : 1367
}

状态码：400

Bad Request

{
  "error_code" : "DRS.10000009",
  "error_msg" : "Parameter error."
}

状态码

状态码

描述

200

OK

400

Bad Request

其他状态请参见状态码。

错误码

请参见错误码。

父主题： 资源管理