查询实例主备切换状态
最近更新时间: 2024-10-18 10:38:32
1. 接口描述
接口请求域名： mariadb.api3.fincloud.tencent.cn。
本接口（DescribeDBInstanceHAInfo）用于查询数据库实例的当前主可用区及主备切换状态。
默认接口请求频率限制：20次/秒。
接口更新时间：2023-02-08 15:40:23。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeDBInstanceHAInfo |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| InstanceId | 是 | 否 | String | 实例Id，形如：tdsql-ow728lmc |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| MasterZone | String | 当前主所在可用区 |
| SwitchStatus | Int64 | 当前切换状态，0-未切换，1-切换中 |
| SwitchAllowed | Bool | 当前是否允许切换 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.DbOperationFailed | |
| InternalError.GetInstanceDetailFailed | |
| InvalidParameter.InstanceNotFound | |
| ResourceUnavailable.InstanceStatusAbnormal | |
| UnauthorizedOperation.PermissionDenied | |
| UnsupportedOperation.InvalidOperation |