查询可用链路信息 - ListLinks

project_id

是

String

参数解释：

租户在某一Region下的Project ID。

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

job_type

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

• migration：实时迁移
• sync：实时同步
• cloudDataGuard：实时灾备
• replay：流量回放

默认取值：

不涉及。

offset

否

Integer

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

0

limit

否

Integer

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

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

job_links

Array of objects

参数解释：

可用链路信息列表，包含每条可用链路的详细配置信息，详情请参见表5。

约束限制：

不涉及。

取值范围：

不涉及。

total_count

Integer

参数解释：

可用链路总条数，表示满足查询条件的链路记录总数量。

约束限制：

不涉及。

取值范围：

不涉及。

job_type

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

engine_type

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

source_endpoint_type

String

参数解释：

源数据库实例类型，标识源数据库的部署方式。

约束限制：

不涉及。

取值范围：

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

target_endpoint_type

String

参数解释：

目标数据库实例类型，标识目标数据库的部署方式。

约束限制：

不涉及。

取值范围：

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

job_direction

String

参数解释：

任务的迁移方向。

约束限制：

不涉及。

取值范围：

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

net_type

String

参数解释：

任务使用的网络类型。

约束限制：

不涉及。

取值范围：

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

task_types

Array of strings

参数解释：

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

约束限制：

不涉及。

取值范围：

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

cluster_modes

Array of strings

参数解释：

可用链路支持的引擎实例模式列表，表示该链路支持的数据库部署架构类型。

约束限制：

不涉及。

取值范围：

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

description

String

参数解释：

链路的描述信息，用于说明该链路的适用场景或功能特点。

约束限制：

不涉及。

取值范围：

不涉及。

error_code

String

参数解释：

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

约束限制：

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

取值范围：

格式为DRS.XXXXXX。

error_msg

String

参数解释：

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

约束限制：

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

取值范围：

不涉及。

200

OK

400

Bad Request