文档首页/分布式缓存服务 DCS/API参考（安卡拉区域）/API V2（推荐）/分片与副本/批量查询实例节点信息
更新时间：2024-11-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量查询实例节点信息

功能介绍

批量查询指定项目所有实例的节点信息、有效实例个数及节点个数。 创建中实例不返回节点信息。 支持Redis4.0及以上版本实例查询。

接口约束

支持Redis4.0及以上版本实例查询。

URI

GET /v2/{project_id}/instances-logical-nodes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

偏移量，表示从此偏移量开始查询，offset大于等于0。

limit

否

Integer

每页显示的条目数量，当前最大值为100。若不设置该参数，则为10。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

count

Integer

查询结果的实例总数。

instances

Array of InstanceNodesInfoResp objects

实例列表。

表4 InstanceNodesInfoResp

参数

参数类型

描述

instance_id

String

实例ID。

node_count

Integer

当前实例节点总数。

nodes

Array of NodesInfoResp objects

节点详情。

表5 NodesInfoResp

参数

参数类型

描述

logical_node_id

String

逻辑节点ID。

name

String

节点名称。

status

String

节点状态，所有值如下:

  • Creating：创建中。

  • Active：运行中。

  • Inactive：故障。

  • Deleting：删除中。

  • AddSharding：添加分片中。

枚举值：

  • Creating

  • Active

  • Inactive

  • Deleting

  • AddSharding

az_code

String

可用区code。

node_role

String

节点角色，所有值如下：

  • redis-server：Redis server节点。

  • redis-proxy：proxy节点。

枚举值：

  • redis-server

  • redis-proxy

node_type

String

节点主从角色：

  • master：主节点

  • slave：从节点

  • proxy: proxy实例节点角色为"proxy"

枚举值：

  • master

  • slave

  • proxy

node_ip

String

节点的IP。

node_port

String

节点的端口。

node_id

String

节点ID。

priority_weight

Integer

节点主备切换优先级权重。

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

副本对应的监控指标维度信息。可用于调用云监控服务的查询监控数据指标相关接口。

  • 副本的监控维度为多维度，返回数组中包含两个维度信息。从云监控查询监控数据时，要按多维度传递指标维度参数，才能查询到监控指标值。

  • 第一个维度为副本父维度信息。 维度名称为dcs_instance_id，维度值对应副本所在的实例ID。

  • 第二个维度，维度名称为dcs_cluster_redis_node，维度值为副本的监控对象ID，与副本ID和节点ID不同。

表6 InstanceReplicationDimensionsInfo

参数

参数类型

描述

name

String

监控维度名称。

value

String

维度取值。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

最大长度：1024

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

最大长度：1024

请求示例

GET https://{dcs_endpoint}/v2/{project_id}/instances-logical-nodes?offset={offset}&limit={limit}

响应示例

状态码： 200

查询节点信息成功。

{
  "count" : 1,
  "instances" : [ {
    "instance_id" : "b4468cb1-4f75-4866-a49d-86959acc0c9c",
    "node_count" : 2,
    "nodes" : [ {
      "logical_node_id" : "8f997eb512a92834bf5914be52ca8919",
      "name" : "(replica)192.168.0.178",
      "status" : "Active",
      "az_code" : "region01",
      "node_role" : "redis-server",
      "node_type" : "slave",
      "node_ip" : "192.168.0.178",
      "node_port" : "6379",
      "node_id" : "8a2c26c17f4d6516017f4d7b77940030",
      "is_access" : true,
      "group_id" : "ace962d1-7841-4e50-9313-c239fd75dee3",
      "group_name" : "group-0",
      "priority_weight" : 100,
      "is_remove_ip" : false,
      "replication_id" : "e40aa09e-03c2-4319-86eb-5ef4ca637544",
      "dimensions" : [ {
        "name" : "dcs_instance_id",
        "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94"
      }, {
        "name" : "dcs_cluster_redis_node",
        "value" : "8263dc69629c5b2d840e9816fa9c6200"
      } ]
    } ]
  } ]
}

状态码： 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

非法请求。

错误码

请参见错误码。

父主题：分片与副本