文档首页/ 数据复制服务 DRS/ API参考/ API v5（公测中）/ 资源管理/ 查询可用链路信息 - ListSupportLinks
更新时间：2026-05-11 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

任务场景。取值：

  • migration：实时迁移。

  • sync：实时同步。

  • cloudDataGuard：实时灾备。

  • replay：录制回放。

  • verify：校验任务。

  • cdc：CDC任务。

offset

否

Integer

偏移量，表示查询该偏移量后面的记录，默认为0，最大为10000。

limit

否

Integer

查询返回记录的数量限制，默认为10，最大为2000。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

否

String

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

X-Auth-Token

是

String

从IAM服务获取的用户Token。

用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。

枚举值：

  • en-us

  • zh-cn

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of objects

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

详情请参见SupportLinksResp。
表5 SupportLinksResp

参数

参数类型

描述

total_count

Integer

列表中的项目总数，与分页无关。

support_links

Array of objects

支持的链路。

详情请参见SupportLinkInfo。
表6 SupportLinkInfo

参数

参数类型

描述

engine_type

String

引擎类型。

net_type

String

网络类型。取值：

  • 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独立部署模式。

job_instance_type

String

DRS实例类型。取值：

  • Single ：单机。

  • Ha：主备。

is_support_bind_eip

Boolean

是否支持绑定EIP

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

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

    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

其他状态请参见状态码。

错误码

请参见错误码。

父主题： 资源管理

相关文档