更新时间:2025-12-29 GMT+08:00

获取副本状态

功能介绍

获取分片副本状态。

URI

GET /v2/{project_id}/instance/{instance_id}/groups/{group_id}/group-nodes-state

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

instance_id

String

实例ID。

group_id

String

分片ID。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

[数组元素]

Array of InstanceReplicationListInfo objects

副本列表

表3 InstanceReplicationListInfo

参数

参数类型

描述

replication_role

String

参数解释

副本角色。

取值范围

  • master:表示主节点。

  • slave:表示从节点。

replication_ip

String

参数解释

副本IP。

取值范围

不涉及。

is_replication

Boolean

参数解释

是否为新增副本。

取值范围

  • true

  • false

replication_id

String

参数解释

副本ID。

取值范围

不涉及。

node_id

String

参数解释

节点ID。

取值范围

不涉及。

status

String

参数解释

副本状态。

取值范围

  • Active:运行中。

  • Inactive:异常。

az_code

String

参数解释

副本所在的可用区。

取值范围

不涉及。

dimensions

Array of InstanceReplicationDimensionsInfo objects

参数解释

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

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

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

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

取值范围

不涉及。

表4 InstanceReplicationDimensionsInfo

参数

参数类型

描述

name

String

参数解释

监控维度名称。

取值范围

  • dcs_instance_id: 实例维度。

  • dcs_cluster_redis_node:数据节点维度。

value

String

参数解释

维度取值。

取值范围

不涉及。

状态码:500

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

请求示例

GET https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/groups/{group_id}/group-nodes-state

响应示例

状态码:200

查询分片和副本信息成功。

[ {
  "az_code" : "region01",
  "is_replication" : false,
  "node_id" : "8abfa7aa73291f15017329e1cda0002d",
  "replication_id" : "dfbd3f84-08bc-42f0-b538-01d03e6dc178",
  "replication_ip" : "192.168.76.25",
  "replication_role" : "master",
  "status" : "Active",
  "dimensions" : [ {
    "name" : "dcs_instance_id",
    "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94"
  } ]
} ]

状态码

状态码

描述

200

查询分片和副本信息成功。

500

内部服务错误。

400

非法请求。

错误码

请参见错误码