集群状态检查
更新时间:2024-03-15
集群状态检查
接口描述
本接口用于检查实例所在集群的状态。
本接口为v1接口。
注意事项
本接口仅支持 Redis 和 Redis 容量型(原 PegaDB)引擎的实例,不支持 Memcache 引擎实例。
请求结构
GET /v{version}/instance/{instanceId}/status HTTP/1.1
Host: redis.bj.baidubce.com
Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | PATH参数 | API版本号。此处值为1 |
instanceId | String | 是 | PATH参数 | 要检查的实例ID。 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
clusterStatus | String | 用于描述集群状态,有两种取值。normal 集群状态正常;abnormal 集群状态不正常。 |
checkList | CheckList | 检查项,每项中:Yes表示检查通过,No表示检查不通过。 所有项检查通过,clusterStatus为normal; 有任意一项检查不通过,clusterStatus为abnormal。 |
CheckList
参数名称 | 类型 | 描述 |
---|---|---|
clusterInstanceStatus | String | 集群实例状态是否正常。Yes表示检查通过,No表示检查不通过。 |
clusterTopology | String | 集群拓扑是否正常。Yes表示检查通过,No表示检查不通过。 |
clusterRedisIsAlived | String | 集群实例是否都存活。Yes表示检查通过,No表示检查不通过。 |
clusterDelay | String | 集群是否存在延迟。Yes表示检查通过,No表示检查不通过。 |
leaderReadOnly | String | 主节点只读检查是否通过。Yes表示检查通过,No表示检查不通过。 |
请求示例
GET http://redis.bj.baidubce.com/v1/instance/scs-bj-ybklwexvscdd/status
Host: redis.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS
{
"clusterStatus": "normal",
"checkList": {
"clusterInstanceStatus": "Yes",
"clusterTopology": "Yes",
"clusterRedisIsAlived": "Yes",
"clusterDelay": "Yes",
"leaderReadOnly": "Yes"
}
}