文档首页/数据复制服务 DRS/API参考/API v5（公测中）/资源管理/查询可用链路信息 - ListLinks
更新时间：2026-02-04 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询可用链路信息 - ListLinks

功能介绍

查询可用链路信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

接口约束

  • 目前仅支持Redis->GeminiDB Redis迁移、Redis集群->GeminiDB Redis迁移、MySQL->MySQL同步、Oracle->GaussDB分布式同步场景。
  • 仅支持部分Region使用，详情参考终端节点。

授权信息

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

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

URI

GET /v5/{project_id}/links

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的Project ID。

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

表2 Query参数

参数

是否必选

参数类型

描述

job_type

是

String

任务场景。取值：

  • migration：实时迁移。
  • sync：实时同步。
  • cloudDataGuard：实时灾备。

枚举值：

  • migration
  • sync
  • cloudDataGuard

offset

否

Integer

偏移量，表示查询该偏移量后面的记录。

limit

否

Integer

查询返回记录的数量限制。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

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

缺省值：application/json

X-Auth-Token

是

String

从IAM服务获取的用户Token。

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

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

X-Language

否

String

请求语言类型。

缺省值：en-us

枚举值：

  • en-us
  • zh-cn

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

job_links

Array of objects

可用链路信息。

详情请参见表5。

total_count

Integer

可用链路总条数。

表5 job_links字段数据结构说明

参数

参数类型

描述

job_type

String

任务场景。取值：

  • migration：实时迁移。
  • sync：实时同步。
  • cloudDataGuard：实时灾备。

枚举值：

  • migration
  • sync
  • cloudDataGuard

engine_type

String

引擎类型。取值：

  • oracle-to-gaussdbv5：Oracle同步到GaussDB分布式版，实时同步场景使用。
  • redis-to-gaussredis：Redis迁移到GeminiDB Redis，实时迁移场景使用。
  • rediscluster-to-gaussredis：Redis集群迁移到GeminiDB Redis，实时迁移场景使用。

枚举值：

  • oracle-to-gaussdbv5
  • redis-to-gaussredis
  • rediscluster-to-gaussredis

source_endpoint_type

String

源数据库实例类型。取值：

  • offline：自建数据库。
  • ecs：华为云ECS自建数据库。
  • cloud：华为云数据库。

枚举值：

  • offline
  • ecs
  • cloud

target_endpoint_type

String

目标数据库实例类型。取值：

  • offline：自建数据库。
  • ecs：华为云ECS自建数据库。
  • cloud：华为云数据库。

枚举值：

  • offline
  • ecs
  • cloud

job_direction

String

迁移方向。取值：

  • up：入云 ，灾备场景时对应本云为备。
  • down：出云，灾备场景时对应本云为主。
  • non-dbs：自建。

枚举值：

  • up
  • down
  • non-dbs

net_type

String

网络类型。取值：

  • eip：公网网络。
  • vpc：VPC网络，灾备场景不支持选择VPC网络。
  • vpn：VPN、专线网络。

枚举值：

  • eip
  • vpc
  • vpn

task_types

Array of strings

迁移模式。取值：

  • FULL_TRANS ：全量。
  • FULL_INCR_TRANS：全量+增量。
  • INCR_TRANS：增量。

枚举值：

  • FULL_TRANS
  • FULL_INCR_TRANS
  • INCR_TRANS

cluster_modes

Array of strings

引擎实例模式。取值：

  • Single：单机模式。
  • Ha：主备模式。
  • Cluster：集群模式。
  • Sharding：分片模式。
  • Independent：GaussDB独立部署模式。

枚举值：

  • Single
  • Ha
  • Cluster
  • Sharding
  • Independent

description

String

链路描述。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：12

最大长度：12

error_msg

String

错误描述。

最小长度：1

最大长度：512

请求示例

  • 查询实时迁移可用链路信息。 
    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/links?job_type=migration
  • 查询实时同步可用链路信息。 
    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/links?job_type=sync
  • 查询实时灾备可用链路信息。 
    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/links?job_type=cloudDataGuard

响应示例

状态码：200

OK

{
  "job_links" : [ {
    "job_type" : "sync",
    "engine_type" : "oracle-to-gaussdbv5",
    "net_type" : "eip",
    "task_types" : [ "FULL_INCR_TRANS", "FULL_TRANS", "INCR_TRANS" ],
    "job_direction" : "up",
    "cluster_modes" : [ "Independent", "Combined" ],
    "source_endpoint_type" : "offline",
    "target_endpoint_type" : "cloud"
  }, {
    "job_type" : "sync",
    "engine_type" : "oracle-to-gaussdbv5",
    "net_type" : "vpn",
    "task_types" : [ "FULL_INCR_TRANS", "FULL_TRANS", "INCR_TRANS" ],
    "job_direction" : "up",
    "cluster_modes" : [ "Independent", "Combined" ],
    "source_endpoint_type" : "offline",
    "target_endpoint_type" : "cloud"
  } ],
  "total_count" : 2
}

状态码：400

Bad Request

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

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题：资源管理

相关文档