查询集群拓扑ring环节点信息
功能介绍
查询集群拓扑ring环节点信息。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/clusters/{cluster_id}/topo/rings
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
cluster_id |
是 |
String |
参数解释: 集群ID。获取方法请参见获取集群ID。 约束限制: 必须是有效的dws集群ID。 取值范围: 36位UUID。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
参数解释: 分页偏移量,从0开始,页数减1。 约束限制: 不涉及。 取值范围: 大于等于0。 默认取值: 0 |
|
limit |
否 |
Integer |
参数解释: 分页单页大小。 约束限制: 不涉及。 取值范围: 大于0。 默认取值: 10 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
cluster_rings |
Array of TopoRingInfo objects |
参数解释: 集群拓扑环列表信息。 取值范围: 不涉及。 |
|
count |
Integer |
参数解释: 集群环数量。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
instance_info_lists |
Array of TopoInstanceInfo objects |
参数解释: 集群实例列表信息。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 实例ID。 取值范围: 不涉及。 |
|
name |
String |
参数解释: 实例名称。 取值范围: 不涉及。 |
|
manage_ip |
String |
参数解释: 实例管理IP。 取值范围: 不涉及。 |
|
traffic_ip |
String |
参数解释: 业务IP。 取值范围: 不涉及。 |
|
internal_ip |
String |
参数解释: 内部通信IP。 取值范围: 不涉及。 |
|
internal_mgnt_ip |
String |
参数解释: 内部管理IP。 取值范围: 不涉及。 |
|
eip |
String |
参数解释: 公网IP信息。 取值范围: 不涉及。 |
|
elb |
String |
参数解释: elb地址。 取值范围: 不涉及。 |
|
status |
String |
参数解释: 实例状态。 取值范围: 不涉及。 |
|
az_code |
String |
参数解释: 可用区编码。 取值范围: 不涉及。 |
请求示例
查询集群拓扑ring环节点信息。
GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/logical-clusters/rings
响应示例
状态码:200
查询集群拓扑环节点信息成功。
{
"cluster_rings" : [ {
"instance_info_lists" : [ {
"id" : "a57e49db-c04b-45c7-9863-f7b6f3eed1b8",
"name" : "ty-default--BGy6PUIN-K-dws-cn-cn-1-1",
"manage_ip" : "172.16.26.233",
"traffic_ip" : "192.168.0.217",
"internal_ip" : "172.16.66.153",
"internal_mgnt_ip" : null,
"eip" : null,
"elb" : null,
"status" : 200,
"az_code" : "cn-north-4c"
}, {
"id" : "3a37f794-be37-42d1-a299-a3eb94888ccb",
"name" : "ty-default--BGy6PUIN-K-dws-cn-cn-2-1",
"manage_ip" : "172.16.34.21",
"traffic_ip" : "192.168.0.80",
"internal_ip" : "172.16.65.89",
"internal_mgnt_ip" : null,
"eip" : null,
"elb" : null,
"status" : 200,
"az_code" : "cn-north-4c"
}, {
"id" : "8763cbf1-5851-44a5-9e71-cbae35201f27",
"name" : "ty-default--BGy6PUIN-K-dws-dn-1-1",
"manage_ip" : "172.16.9.16",
"traffic_ip" : "192.168.0.88",
"internal_ip" : "172.16.67.64",
"internal_mgnt_ip" : null,
"eip" : null,
"elb" : null,
"status" : 200,
"az_code" : "cn-north-4c"
} ]
} ],
"count" : 1
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询集群拓扑环节点信息成功。 |
|
400 |
请求错误。 |
|
401 |
鉴权失败。 |
|
403 |
没有操作权限。 |
|
404 |
找不到资源。 |
|
500 |
服务内部错误。 |
|
503 |
服务不可用。 |