该接口用于开启或关闭RDS实例的主备自动切换功能。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:ModifyHASwitchConfig | Write |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 实例ID。可调用DescribeDBInstances获取。 | rm-uf6wjk5**** |
| HAConfig | string | 否 | 主备切换设置，取值：
默认值：Auto。 说明
取值为Manual时，必须传入参数ManualHATime。
| Manual |
| ManualHATime | string | 否 | 临时关闭的截止时间。最晚可设置为7天后的23:59:59。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。 说明
仅当参数HAConfig取值为Manual时，本参数有效。
| 2019-08-29T15:00:00Z |
| RegionId | string | 是 | 地域ID，可以通过接口DescribeRegions查看地域ID。 | cn-hangzhou |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "B6AE1448-D846-4831-B1C7-CFF3E99D5470"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | HaConfig.Format | The value of HaConfig must be auto or manual | 主备自动切换值必须配置为自动或手动。 |
| 400 | HaConfigIsNull | HaConfig is null. | 主备自动切换参数值为null。 |
| 400 | ManualHATime.Format | Invalid format of ManualHATime. | - |
| 400 | ManualHATimeIsNull | ManualHATime can not be null when the value of haConfig is Manual. | 当haConfig的值为Manual时，ManualHATime不能为空。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||
|---|---|---|---|---|---|---|
| 2023-09-08 | OpenAPI 错误码发生变更 | 看变更集 | ||||
| ||||||
| 2022-09-01 | OpenAPI 错误码发生变更 | 看变更集 | ||||
|