全部产品
Search
文档中心

云数据库 RDS:SwitchDBInstanceHA - RDS实例主备切换

更新时间:Mar 13, 2024

该接口用于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:SwitchDBInstanceHAWRITE
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

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

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
NodeIdstring

备库的唯一标识,通过接口 DescribeDBInstanceHAConfig 可查询该值。

349054
Forcestring

切换方式,取值:

  • Yes:强制
  • No:非强制

默认值:No

No
EffectiveTimestring

生效时间,取值:

  • Immediate:立即执行
  • MaintainTime:可维护时间内执行

默认值:Immediate

Immediate

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC

示例

正常返回示例

JSON格式

{
  "RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC"
}

错误码

HTTP status code错误码错误信息描述
400GeneralIns.CreatingThe general instance is creating.目前有实例还在生产中,请稍等
400GeneralIns.MaintainingThe general instance is maintaining.有实例在迁移或维护中,请稍等
400GeneralIns.SwitchingThe general instance is Switching.HA切换中,请稍等
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。

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

变更历史

变更时间变更内容概要操作
2022-06-23OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400