强制切换热活实例组
更新时间:2023-04-24
接口说明
强制切换热活实例组,新主角色ID所在地域必须与当前请求的地域保持一致。
请求URI
PUT /v{version}/instance/group/{groupId}/forceChange
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
---|---|---|---|---|---|
version | String | 是 | API 版本号 | version_example | Path |
groupId | String | 是 | 实例组id | groupId_example | Path |
请求体参数
请求体字段数据结构说明
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
---|---|---|---|---|
leaderId | String | 是 | 实例组中要切换为主角色的实例id | rds-y9dJu77d |
force | Integer | 否 | 0 - 非故障(非故障状态时使用)1 - 故障 | 1 |
maxBehind | Integer | 否 | 最大允许备库Behind_Master值(0 表示要求备库和故障主库数据完全一致,建议业务从0开始逐步增加,直至最大容忍值,force=0时,该参数不生效 ) | 10 |
响应体参数
响应体字段数据结构说明
参数名称 | 参数类型 | 描述 | 示例值 |
---|---|---|---|
behindMaster | Integer | 切换时备库延迟 | 0 |
请求示例
PUT /vversion_example/group/instance/groupId_example/forceChange
<公共请求头>
{
"force" : 1,
"leaderId" : "rds-y9dJu77d",
"maxBehind" : 10
}
响应示例
HTTP/1.1 200 OK
<公共响应头>
{
"behindMaster" : 0
}
错误码
请参考通用错误码