首页 云数据库 RDS 开发参考 API参考 API目录 主备高可用和数据复制方式 ModifyHASwitchConfig - 开启或关闭RDS实例的主备自动切换功能

ModifyHASwitchConfig - 开启或关闭RDS实例的主备自动切换功能

更新时间: 2023-09-26 14:26:46

该接口用于开启或关闭RDS实例的主备自动切换功能。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:ModifyHASwitchConfigWrite
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例ID。可调用DescribeDBInstances获取。

rm-uf6wjk5****
HAConfigstring

主备切换设置,取值:

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

默认值:Auto

说明 取值为Manual时,必须传入参数ManualHATime
Manual
ManualHATimestring

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

说明 仅当参数HAConfig取值为Manual时,本参数有效。
2019-08-29T15:00:00Z
RegionIdstring

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

cn-hangzhou

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求ID。

B6AE1448-D846-4831-B1C7-CFF3E99D5470

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400HaConfig.FormatThe value of HaConfig must be auto or manual主备自动切换值必须配置为自动或手动。
400HaConfigIsNullHaConfig is null.主备自动切换参数值为null。
400ManualHATime.FormatInvalid format of ManualHATime.-
400ManualHATimeIsNullManualHATime can not be null when the value of haConfig is Manual.当haConfig的值为Manual时,ManualHATime不能为空。

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

变更历史

变更时间变更内容概要操作
2023-09-08OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2022-09-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
阿里云首页 云数据库 RDS 相关技术圈