查询实例节点信息
功能介绍
查询指定实例的节点信息。
支持Redis4.0及以上版本实例查询。
创建中的实例不返回节点信息。
接口约束
支持Redis4.0及以上版本实例查询。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/instances/{instance_id}/logical-nodes
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
instance_id |
是 |
String |
实例ID。 |
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
instance_id |
String |
实例ID。 |
total |
Integer |
节点数量。 |
nodes |
Array of NodesInfoResp objects |
节点信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
logical_node_id |
String |
参数解释: 逻辑节点ID。 取值范围: 不涉及。 |
name |
String |
参数解释: 节点名称。 取值范围: 不涉及。 |
status |
String |
参数解释: 节点状态。 取值范围:
|
az_code |
String |
参数解释: 可用区code。 取值范围: 不涉及。 |
node_role |
String |
参数解释: 节点角色。 取值范围:
|
node_type |
String |
参数解释: 节点主从角色。 取值范围:
|
node_ip |
String |
参数解释: 节点的IP。 取值范围: 不涉及。 |
node_port |
String |
参数解释: 节点的端口。 取值范围: 不涉及。 |
node_id |
String |
参数解释: 节点ID。 取值范围: 不涉及。 |
priority_weight |
Integer |
参数解释: 节点主备切换优先级权重。 取值范围: 0-100(1-100优先级逐步降低,1为最高,100为最低,0为禁止倒换)。 |
is_access |
Boolean |
参数解释: 节点的IP是否可直接访问。 取值范围:
|
group_id |
String |
参数解释: 实例分片ID。 取值范围: 不涉及。 |
group_name |
String |
参数解释: 实例分片名称。 取值范围: 不涉及。 |
is_remove_ip |
Boolean |
参数解释: 是否从只读域名中摘除IP。 取值范围:
|
replication_id |
String |
参数解释: 实例副本ID。 取值范围: 不涉及。 |
dimensions |
Array of InstanceReplicationDimensionsInfo objects |
参数解释: 副本对应的监控指标维度信息。可用于调用云监控服务的查询监控数据指标相关接口。
取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 监控维度名称。 取值范围:
|
value |
String |
参数解释: 维度取值。 取值范围: 不涉及。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。 取值范围: 请参见错误码。 |
error_ext_msg |
String |
参数解释: 扩展错误信息(暂未使用,赋值为null)。 取值范围: 不涉及。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。 取值范围: 请参见错误码。 |
error_ext_msg |
String |
参数解释: 扩展错误信息(暂未使用,赋值为null)。 取值范围: 不涉及。 |
请求示例
GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/logical-nodes?status={status}
响应示例
状态码: 200
查询节点信息成功。
{ "instance_id" : "11368fbb-de1e-4613-9080-1c374b71a1af", "total" : 1, "nodes" : [ { "logical_node_id" : "79653bcbd0e5c104fefedd188aa372d6", "name" : "(master)192.168.68.157", "status" : "Active", "az_code" : "region01", "node_role" : "redis-server", "node_type" : "master", "node_ip" : "192.168.68.157", "node_id" : "ff80808189bf92a50189d330303b77aa", "is_access" : true, "group_id" : "6e0f6e95-57cd-4baf-86d6-bea8815b25a8", "group_name" : "group-0", "priority_weight" : 100, "is_remove_ip" : false, "dimensions" : [ { "name" : "dcs_instance_id", "value" : "11368fbb-de1e-4613-9080-1c374b71a1af" }, { "name" : "dcs_cluster_redis_node", "value" : "79653bcbd0e5c104fefedd188aa372d6" } ], "replication_id" : null } ] }
状态码: 500
内部服务错误。
{ "error_code" : "DCS.5000", "error_msg" : "Internal service error." }
状态码: 400
非法请求。
{ "error_code" : "DCS.4800", "error_msg" : "Invalid offset in the request." }
状态码
状态码 |
描述 |
---|---|
200 |
查询节点信息成功。 |
500 |
内部服务错误。 |
400 |
非法请求。 |
错误码
请参见错误码。