You need to enable JavaScript to run this app.
导航

SwitchDBMaster

最近更新时间2023.06.06 15:55:20

首次发布时间2023.06.06 15:37:36

调用 SwitchDBMaster 接口手动切换指定实例的主从节点。

请求类型

异步请求。

前提条件

  • 实例状态需为运行中(即 InstanceStatusRunning)。关于实例状态的更多详情,请参见实例状态说明
  • 需要进行手动切换节点,必须是如下任一实例或组件类型中的从节点
    • 副本集实例
    • 分片集群实例中 Shard 分片
    • 分片集群实例中 ConfigServer 组件

注意事项

  • 手动切换主节点过程(一般需要 30~60 秒)中,实例可能会出现 1~2 次连接闪断,请谨慎操作。建议在业务低峰期执行切换操作,并确保应用具备自动重连机制。
  • 手动切换主节点仅改变节点的角色,不会改变节点所在的可用区和节点 ID。

请求参数

名称类型是否必选示例值描述

InstanceId

String

mongo-shard-011d2479****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息,包括实例 ID。

NodeId

String

mongo-shard-100b2c546f14-s0-1

需要进行主从切换的从节点 ID。

说明

必须传入从节点(即 NodeRoleSecondary)的节点 ID,不支持将隐藏节点(即 NodeRoleHidden)切换为主节点。您可以调用 DescribeDBInstanceDetail 接口查询目标实例分片集群实例下所有节点的信息,包括节点角色。

返回数据

null

请求示例

  • 手动切换副本集实例的主从节点角色。

    POST https://mongodb.volcengineapi.com/?Action=SwitchDBMaster&Version=2022-01-01 HTTP/1.1
    Host: mongodb.volcengineapi.com
    Content-Type: application/json; charset=utf-8
    X-Date: 20201103T104027Z
    Authorization: HMAC-SHA256 Credential=AK*/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=*
    {
            "InstanceId": "mongo-replica-c81b6e56****",
            "NodeId": "mongo-replica-c81b6e56****-1"
    }
    
  • 手动切换分片集群实例中某一 Shard 分片的主从节点角色。

    POST https://mongodb.volcengineapi.com/?Action=SwitchDBMaster&Version=2022-01-01 HTTP/1.1
    Host: mongodb.volcengineapi.com
    Content-Type: application/json; charset=utf-8
    X-Date: 20201103T104027Z
    Authorization: HMAC-SHA256 Credential=AK*/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=*
    {
            "InstanceId": "mongo-shard-100b2c54****",
            "NodeId": "mongo-shard-100b2c54****-s0-1"
    }
    
  • 手动切换分片集群实例中 ConfigServer 的主从节点角色。

    POST https://mongodb.volcengineapi.com/?Action=SwitchDBMaster&Version=2022-01-01 HTTP/1.1
    Host: mongodb.volcengineapi.com
    Content-Type: application/json; charset=utf-8
    X-Date: 20201103T104027Z
    Authorization: HMAC-SHA256 Credential=AK*/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=*
    {
            "InstanceId": "mongo-shard-100b2c54****",
            "NodeId": "mongo-shard-100b2c54****-config-0"
    }
    

返回示例

正常返回示例

{
        "ResponseMetadata": {
                "RequestId": "202305161612331350F38EC0C05BC2****",
                "Action": "SwitchDBMaster",
                "Version": "2022-01-01",
                "Service": "mongodb",
                "Region": "cn-beijing"
        },
        "Result": null
}