接口功能介绍
查询RDS实例主备自动切换设置。
接口约束
引擎为5.7的RDS实例,8.0默认自动切换。
URI
GET /v1/open-api/instance/describe-ha-switch-config
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstId | 是 | String | 主机实例id | 3 |
路径参数
无
请求参数
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码 | 0 | |
message | 是 | String | 返回消息 | ||
returnObj | 是 | Object | 返回对象 | switchConfig |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
switchConfig | 是 | String | 自动切换设置,auto代表自动切换,manual代表手动切换 | auto |
请求示例
请求头header
无
请求体body
无
响应示例
{
"statusCode":0,
"message":"success",
"returnObj":{
"switchConfig":"auto"
}
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |