查询实例主备平衡状态 - CheckingWhetherHostLoadIsUnbalancedDuetoaPrimary/StandbySwitchover
调试
您可以在API Explorer中调试该接口。
URI
GET /v3/{project_id}/instances/{instance_id}/balance
| 名称 | 是否必选 | 参数类型 | 说明 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
| instance_id | 是 | String | 参数解释: 实例ID,此参数是用户创建实例的唯一标识。请参考查询数据库实例列表 - QueryingDBInstances接口获取实例ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为36个字符。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| X-Language | 否 | String | 参数解释: 语言。 约束限制: 不涉及。 取值范围:
默认取值: en-us |
响应参数
| 名称 | 参数类型 | 说明 |
|---|---|---|
| balanced | Boolean | 参数解释: 平衡状态。显示是否有集群实例发生过主备切换而导致主机负载不均衡。 取值范围:
|
请求示例
查询实例主备平衡状态。
GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instance/dsfae23fsfdsae3435in14/balance
响应示例
查询实例主备平衡状态成功。
{
"balanced": true
} 状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。