SwitchDBInstanceHA_云数据库 MongoDB 版_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

说明
  • 本接口适用于副本集实例和分片集群实例,暂不支持单节点实例。
  • 副本集实例以实例为单位进行切换,分片集群实例以 Shard 为单位进行切换。
  • 流控信息

    请求速率为500/60(s)。更多流控信息,请前往配额中心查看

    授权信息

    当前云产品暂无权限信息透出。

    请求参数

    字段名称字段详情
    DBInstanceIdstring

    实例 ID。

    示例值:dds-bpxxxxxxxx参考取值来源:
      CreateDBInstance
      DescribeDBInstances
    NodeIdstring

    分片集群实例中 Shard 节点的 ID。展开详情

    示例值:d-bpxxxxxxxx参考取值来源:
      CreateNode
    RoleIdsstring

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

    示例值:972xxxx,972xxxx参考取值来源:
      DescribeRoleZoneInfo
    SwitchModeinteger<int32>

    切换主备节点的时间点。取值:展开详情

    示例值:0枚举值:01取值 <= 1

    返回参数

    字段名称字段详情
    RequestIdstring

    请求 ID。

    示例值:26BD4E5F-BDB4-47BA-B232-413AA78CFA8F

    返回示例

    错误码

    全局错误码
    HTTP 状态码错误码错误信息操作
    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.诊断

    变更历史

    变更时间变更内容概要操作
    2023-07-13
    删除返回参数
    2023-01-05
    新增返回参数

    相关示例

    角色转换
    2021-11-22