全部产品
Search

搜索本产品

    云数据库 MongoDB：SwitchDBInstanceHA - 切换实例中的主备节点

    文档中心

    云数据库 MongoDB：SwitchDBInstanceHA - 切换实例中的主备节点

    更新时间：Jan 26, 2026

    切换MongoDB实例中的主备节点。

    接口说明

    调用本接口时，实例状态要求为运行中。

    说明

    • 本接口适用于副本集实例和分片集群实例，暂不支持单节点实例。

    • 副本集实例以实例为单位进行切换，分片集群实例以 Shard 为单位进行切换。

    调试

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

    调试

    授权信息

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

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

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

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

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

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

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

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

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    dds:SwitchDBInstanceHA

    none

    *Instance

    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    DBInstanceId

    string

    是

    实例 ID。

    dds-bpxxxxxxxx
    NodeId

    string

    否

    分片集群实例中 Shard 节点的 ID。

    说明

    当 DBInstanceId 参数传入的是分片集群实例 ID 时，本参数必须传入。

    d-bpxxxxxxxx
    RoleIds

    string

    否

    需要执行切换的角色 ID。您可以调用 DescribeRoleZoneInfo 接口获取角色 ID 和节点角色信息。

    说明

    • 角色 ID 以英文逗号（,）分隔，不传入本参数则切换主备节点。

    • 当 DBInstanceId 参数传入的是分片集群实例 ID 时，执行切换的角色必须属于同一 Shard 节点中。

    972xxxx,972xxxx
    SwitchMode

    integer

    否

    切换主备节点的时间点。取值：

    • 0：立即切换。

    • 1：在可运维时间段内切换。

    0

    返回参数

    名称

    类型

    描述

    示例值

    object

    RequestId

    string

    请求 ID。

    26BD4E5F-BDB4-47BA-B232-413AA78CFA8F

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "26BD4E5F-BDB4-47BA-B232-413AA78CFA8F"
}

    错误码

    HTTP status code

    错误码

    错误信息

    描述
    400 InvalidSwitchType Specified Swtich Type is not valid.
    400 InvalidInstanceId Specified Instance ID is not valid.
    400 HaStatusNotSupport Current DB instance HA status does not support this operation.

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

    变更历史

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