角色切换
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DBClusterId |
string |
是 |
集群 ID。 |
pc-************** |
| TargetDBNodeId |
string |
否 |
将要切换为主节点的节点 ID，如果不填，则系统自动选举。您可以通过接口 DescribeDBClusters 查询节点 ID 等信息。 |
pi-*********** |
| RollBackForDisaster |
boolean |
否 |
是否是故障切换后的回切至原主可用区，取值范围如下：
|
false |
| ClientToken |
string |
否 |
用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。 |
6000170000591aed949d0f54a343f1a4233c1e7d1c5****** |
| TargetZoneType |
string |
否 |
是否是主可用区内主备切换，取值如下：
|
Primary |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
925B84D9-CA72-432C-95CF-738C22****** |
示例
正常返回示例
JSON格式
{
"RequestId": "925B84D9-CA72-432C-95CF-738C22******"
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | HaStatusNotSupport | Current DB instance HA status does not support this operation. | 实例的HA状态不支持该操作 |
| 400 | InvalidDBNodeId.Malformed | The specified parameter DBNodeId is not valid. | 指定的参数DBNodeId无效。 |
| 400 | InvalidDBType.Malformed | The Specified DBType is not valid. | 指定的数据库类型无效. |
| 400 | UnsupportHighFrequenceSwitchOver | The instance has switch over too frequent within ten minutes. | 当前切换过于频繁，建议5分钟后重试 |
| 400 | UnsupportWitchUnhealthyReplication | The action is unsupported with unhealthy replication. | 当前复制关系异常，不支持切换 |
| 403 | OperationDenied.DBNodeType | The operation is not permitted due to type of node. | 操作失败，节点类型不允许此操作。 |
| 403 | OperationDenied.ClusterCategory | The operation is not permitted due to cluster category. | 该集群不支持此产品系列。 |
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 当前的记录中不存在提供的DBClusterId。 |
| 404 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | 指定的参数DBClusterId无效 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。