对PolarDB集群进行手动主备切换，可以指定一个只读节点为新的主节点。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| polardb:FailoverDBCluster | update |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBClusterId | string | 是 | 数据库集群 ID。 | pc-************** |
| TargetDBNodeId | string | 否 | 将要切换为主节点的节点 ID，如果不填，则系统自动选举。您可以通过接口 DescribeDBClusters 查询节点 ID 等信息。 说明
| pi-*********** |
| RollBackForDisaster | boolean | 否 | 是否是故障切换后的回切至原主可用区，取值范围如下：
| false |
| ClientToken | string | 否 | 用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。 | 6000170000591aed949d0f54a343f1a4233c1e7d1c5****** |
| TargetZoneType | string | 否 | 是否是主可用区内主备切换，取值如下：
| Primary |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
}错误码
| 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无效 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-08-20 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-08-08 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-12-07 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-09-12 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-06-12 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2022-06-10 | OpenAPI 错误码发生变更 | 查看变更详情 |