文档首页/ 云数据库 GeminiDB/ API参考/ API v3(推荐)/ 实例管理/ Redis主备切换 - PerformingaPrimary/StandbySwitchover
更新时间:2025-11-27 GMT+08:00

Redis主备切换 - PerformingaPrimary/StandbySwitchover

功能介绍

切换实例的主备节点。

接口约束

该接口支持如下数据库实例:

  • GeminiDB Redis 主备版

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    gaussdbfornosql:instance:switchover

    Write

    instance *

    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId

    nosql:dr:switchoverDisasterRecovery

    -

URI

PUT /v3/{project_id}/instance/{instance_id}/switchover

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户在某一region下的project ID。获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

instance_id

String

参数解释:

实例ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码: 202

表3 响应Body参数

参数

参数类型

描述

job_id

String

参数解释:

任务ID。

取值范围:

不涉及。

请求示例

PUT https://{Endpoint}/v3/2900b7b8d03e4619b8db8d43bc6234ee/instance/f42ecf40870644b288884742bff6ef51in12/switchover

响应示例

状态码: 202

Accepted.

{ 
   "job_id" : "528747ac-c30b-4904-a4ed-806c6943ec96" 
 }

状态码

请参见状态码

错误码

请参见错误码