调用ModifyHASwitchConfig接口开启或关闭RDS实例的主备切换功能。

主备实例切换后原来的主实例会变成备实例。详情请参见切换主备实例

调用该接口时,实例版本必须为MySQL高可用版。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyHASwitchConfig

系统规定参数,取值:ModifyHASwitchConfig

RegionId String cn-hangzhou

地域ID,可以通过接口DescribeRegions查看地域ID。

DBInstanceId String rm-uf6wjk5xxxxxxxxxx

实例ID。

HAConfig String Manual

主备切换设置,取值:

  • Auto:出现故障时自动切换主备实例;
  • Manual:临时关闭自动切换。

默认值:Auto

说明 取值为Manual时,必须传入参数ManualHATime
ManualHATime String 2019-08-29T15:00:00Z

临时关闭的截止时间。最晚可设置为7天后的23:59:59。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

说明 仅当参数HAConfig取值为Manual时,本参数有效。
AccessKeyId String LTAIfCxxxxxxx

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

返回数据

名称 类型 示例值 描述
RequestId String B6AE1448-D846-4831-B1C7-CFF3E99D5470

请求ID。

示例

请求示例


http(s)://rds.aliyuncs.com/?Action=ModifyHASwitchConfig
&RegionId=cn-hangzhou
&DBInstanceId=rm-uf6wjk5xxxxxxxxxx
&HAConfig=Manual
&ManualHATime=2019-08-28T15:00:00
&<公共请求参数>

正常返回示例

XML 格式

<ModifyHASwitchConfigResponse>
  <RequestId>B6AE1448-D846-4831-B1C7-CFF3E99D5470</RequestId>
</ModifyHASwitchConfigResponse>

JSON 格式

{
	"RequestId":"B6AE1448-D846-4831-B1C7-CFF3E99D5470"
}

错误码

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