查询DDM实例节点列表
功能介绍
查询DDM实例节点列表。
接口约束
无
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/instances/{instance_id}/nodes?offset={offset}&limit={limit}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户在某一region下的project ID。 获取方法请参见获取项目ID。 |
|
instance_id |
是 |
String |
DDM实例ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0。 取值必须为数字，且不能为负数。 |
|
limit |
否 |
Integer |
查询个数上限值。 取值范围：1~128。 不传该参数时，默认值为128。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务的“获取用户Token”接口来获取。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
nodes |
Array of NodeList objects |
DDM实例节点信息列表的集合。 |
|
offset |
Integer |
分页参数: 起始值。 |
|
limit |
Integer |
分页参数：每页多少条。 |
|
total |
Integer |
DDM实例节点个数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
port |
String |
端口。 |
|
status |
String |
节点状态。 |
|
node_id |
String |
节点ID。 |
|
ip |
String |
IP。 |
|
group_id |
String |
节点所在组ID。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
errCode |
String |
业务错误码。 |
|
externalMessage |
String |
错误信息。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
errCode |
String |
业务错误码。 |
|
externalMessage |
String |
错误信息。 |
请求示例
查询实例节点列表。
GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/nodes?offset={offset}&limit={limit}
响应示例
状态码： 200
OK
{
"nodes" : [ {
"port" : "5066",
"status" : "normal",
"node_id" : "4a2b97b7f5e3462c9c78aae93b46ed83no09",
"ip" : "192.168.0.160",
"group_id": "b4153b807b1a4f83870bf868fcc4f4eagr09"
} ],
"offset" : 0,
"limit" : 128,
"total" : 1
}
状态码： 400
bad request
{
"externalMessage" : "Parameter error.",
"errCode" : "DBS.280001"
}
状态码： 500
server error
{
"externalMessage" : "Server failure.",
"errCode" : "DBS.200412"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
bad request |
|
500 |
server error |
错误码
请参见错误码。
