文档首页/ 分布式数据库中间件 DDM/ API参考/ API(推荐)/ 逻辑库管理/ 查询分片变更可选取的数据节点实例列表V3
更新时间:2026-05-15 GMT+08:00
分享

查询分片变更可选取的数据节点实例列表V3

功能介绍

查询分片变更可选取的数据节点实例列表

URI

GET /v3/{project_id}/instances/{instance_id}/databases/{db_name}/migration/available-data-nodes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一region下的project ID。

instance_id

String

DDM实例ID

db_name

String

逻辑库名称

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 Query参数

参数

是否必选

参数类型

描述

offset

Integer

索引位置,偏移量。

从第一条数据偏移offset条数据后开始查询,默认为0。

取值必须为数字,且不能为负数。

limit

Integer

查询个数上限值。

取值范围:1~128。

不传该参数时,默认值为10。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data_nodes

Array of AvailableDnInstance objects

可用后端DN信息。

表5 AvailableDnInstance

参数

参数类型

描述

id

String

DN实例ID。

status

String

DN实例状态。

name

String

DN实例名称。

engine_name

String

DN实例引擎名称。

engine_version

String

DN实例引擎版本。

private_ip

String

DN实例私有IP。

port

Integer

DN实例端口。

time_zone

String

DN实例时区。

状态码:400

表6 响应Body参数

参数

参数类型

描述

errCode

String

错误码。

externalMessage

String

错误消息。

状态码:500

表7 响应Body参数

参数

参数类型

描述

errCode

String

错误码。

externalMessage

String

错误消息。

请求示例

响应示例

状态码:400

bad request

{
  "error_msg" : "Parameter error.",
  "error_code" : "DBS.280001"
}

状态码:500

server error

{
  "error_msg" : "Parameter error.",
  "error_code" : "DBS.280001"
}

状态码

状态码

描述

200

ok

400

bad request

500

server error

错误码

请参见错误码

相关文档