该接口用于手动对POLARDB集群进行主备切换，可以指定一个只读节点为新的主节点。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
DBClusterId String 是 pc-xxxxxxxxxxxxxxxx

数据库集群ID。
AccessKeyId String 否 key-test

阿里云颁发给用户的访问服务所用的密钥ID。
Action String 否 FailoverDBCluster

系统规定参数，取值：FailoverDBCluster。

ClientToken String 否 6000170000591aed949d0f54a343f1a4233c1e7d1c5ca816bf

用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。
TargetDBNodeId String 否 pi-xxxxxxxxxx

将要切换为主节点的节点ID，如果不填，则系统自动选举。您可以通过接口DescribeDBClusters查询节点ID等信息。

说明 自动选举主节点： 系统找出当前可以被选举的所有只读节点。选择优先级最高的一个或多个只读节点。如果切换第一个节点失败（例如，网络原因、复制状态异常等），则会尝试切换下一个，直至成功。

返回数据

名称 类型 示例值 描述
RequestId String D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC

请求ID。

示例

请求示例


http(s)://[Endpoint]/?Action=FailoverDBCluster
&DBClusterId=pc-xxxxxxxxxxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式 

<FailoverDBClusterResponse>  
	    <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>
</FailoverDBClusterResponse>

JSON 格式 

{
	"RequestId":"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC"
}

错误码

访问错误中心查看更多错误码。