文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 实例管理/ 手动倒换主备 - StartFailover
更新时间：2025-11-21 GMT+08:00
查看PDF
分享

手动倒换主备 - StartFailover

功能介绍

您可以根据业务需要，手动倒换主备实例。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:instance:switchover

write

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

-

-

接口约束

  • 仅支持HA实例。
  • 实例在创建、重启、数据库升级、变更规格、恢复、修改端口、删除用户、创建用户时不能进行此操作。
  • 主备倒换不会改变实例的内网地址。

URI

  • URI格式

    PUT /v3/{project_id}/instances/{instance_id}/failover

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    租户在某一Region下的项目ID。

    获取方法请参见获取项目ID。

    instance_id

    是

    实例ID。

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

force

否

Boolean

是否强制倒换主备实例。默认为空，表示不强制倒换。

  • true：强制倒换。
  • false：不强制倒换。
    说明：

    该参数仅对PostgreSQL引擎有效。

请求示例

  • 不强制倒换主备实例。 
    PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/failover
{}
  • 强制倒换主备实例。 
    {
"force":true
}

响应消息

  • 正常响应要素说明

    名称

    说明

    workflowId

    任务ID。

    instanceId

    实例ID。

    nodeId

    节点ID。
  • 正常响应样例 
    {
    "workflowId":"072beb09-0573-40bf-bfe8-4be5cec9e85a",
    "instanceId":"794c38e5309344818f4b33b86ebce9b4in03",
    "nodeId":"b94ba815747040f1b0d641cd13364a06no03"
}
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 实例管理

相关文档