全部产品
Search

搜索本产品

    云数据库 OceanBase （文档停止维护）：SwitchoverInstance - 切换主备实例

    文档中心

    云数据库 OceanBase （文档停止维护）：SwitchoverInstance - 切换主备实例

    更新时间：Aug 28, 2026

    切换 OceanBase 主备实例。

    调试

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

    调试

    授权信息

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

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    oceanbase:SwitchoverInstance

    update

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    InstanceId

    string

    是

    主备实例 ID，默认可以使用需要切换为主实例的实例 ID。

    ob317v4uif****
    TargetInstanceId

    string

    是

    需要切换为主实例的实例 ID。

    ob4bv8o7sp****
    Forced

    boolean

    否

    是否强制切换主备实例。取值范围：

    • true：表示强制切换主备实例。

    • false：表示不强制切换主备实例。

    true

    返回参数

    名称

    类型

    描述

    示例值

    object

    请求的返回结果。

    RequestId

    string

    请求 ID。

    473469**-AA6F-4D**-B3DB-A***********
    Data

    object

    切换主备实例数据列表。

    Message

    string

    切换主备实例信息。

    delete tag-value success
    Success

    boolean

    是否修改成功。

    • true：修改成功。

    • false：修改失败。

    true

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "473469**-AA6F-4D**-B3DB-A***********",
  "Data": {
    "Message": "delete tag-value success",
    "Success": true
  }
}

    错误码

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

    变更历史

    更多信息，参考变更详情。