集群状态检查
更新时间：2023-09-08
接口描述
本接口用于检查实例所在集群的状态。
本接口为v1接口。
注意事项
本接口适用于MySQL引擎类型的实例，接口允许传入双机高可用版实例，允许传入MySQL引擎类型的只读实例。
请求结构
GET /v{version}/instance/{instanceId}/status HTTP/1.1
Host: rds.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | PATH参数 | API版本号，此处值为1。 |
| instanceId | String | 是 | PATH参数 | 要检查的实例ID。 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| clusterStatus | String | 用于描述集群状态，有两种取值。normal 集群状态正常；abnormal 集群状态不正常。 |
| checkList | CheckStatusResponse | 检查项，每项中：Yes表示检查通过，No表示检查不通过。所有项检查通过，clusterStatus为normal；有任意一项检查不通过，clusterStatus为abnormal； |
CheckStatusResponse
| 参数名称 | 类型 | 描述 |
|---|---|---|
| clusterInstanceStatus | String | 集群中实例状态检查结果，有两种取值。Yes表示检查通过，No表示检查不通过。 |
| clusterTopology | String | 集群中实例拓扑信息检查结果，有两种取值。Yes表示检查通过，No表示检查不通过。 |
| clusterMySQLIsAlived | String | 实例探活检查结果，有两种取值。Yes表示检查通过，No表示检查不通过。 |
| clusterDelay | String | 集群延迟状态检查结果，有两种取值。Yes表示检查通过，No表示检查不通过。 |
| leaderReadOnly | String | 若实例属于热活组，检查热活组内leader是否非只读，follower是否只读 |
请求示例
GET http://rds.bj.baidubce.com/v1/instance/rds-sddfefcx/status
Host: rds.bj.baidubce.com
Content-Type: application/json;charset=UTF-8
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": {
"clusterStatus": "Yes",
"clusterTopology": "Yes",
"clusterMySQLIsAlived": "Yes",
"clusterDelay": "Yes",
"leaderReadOnly": "Yes"
}
}