文档数据库 MongoDB 版
文档数据库 MongoDB 版
文档指南
请输入
- 文档首页
文档数据库 MongoDB 版API 参考实例管理SwitchDBMaster
复制全文
下载 pdfSwitchDBMaster
文档反馈
问问助手调用 SwitchDBMaster 接口手动切换目标 MongoDB 实例的主从节点。
请求类型
异步请求。
注意事项
- 实例状态需为运行中（即 InstanceStatus 为 Running）。关于实例状态的更多详情，请参见实例状态说明。
- 需要进行手动切换节点，必须是如下任一实例或组件类型中的从节点：
- 副本集实例
- 分片集群实例中 Shard 分片
- 分片集群实例中 ConfigServer 组件
- 手动切换主节点过程（一般需要 30~60 秒）中，实例可能会出现 1~2 次连接闪断，请谨慎操作。建议在业务低峰期执行切换操作，并确保应用具备自动重连机制。
- 手动切换主节点仅改变节点的角色，不会改变节点所在的可用区和节点 ID。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
InstanceId String 必选 示例值：mongo-shard-011d2479****
实例 ID。
说明
NodeId String 必选 示例值：mongo-shard-100b2c546f14-s0-1
需要进行主从切换的从节点 ID。
说明
必须传入从节点（即 NodeRole 为 Secondary）的节点 ID，不支持将隐藏节点（即 NodeRole 为 Hidden）切换为主节点。您可以调用 DescribeDBInstanceDetail接口查询目标实例分片集群实例下所有节点的信息，包括节点角色。
返回参数
示例
请求示例 1
手动切换副本集实例的主从节点角色。
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=SwitchDBMaster&Version=2022-01-01 HTTP/1.1
Host: mongodb.cn-beijing.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"
}
返回示例 1
{
"ResponseMetadata": {
"RequestId": "202305161612331350F38EC0C05BC25BC2",
"Action": "SwitchDBMaster",
"Version": "2022-01-01",
"Service": "mongodb",
"Region": "cn-beijing"
},
"Result": null
}
请求示例 2
手动切换分片集群实例中某一 Shard 分片的主从节点角色。
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=SwitchDBMaster&Version=2022-01-01 HTTP/1.1
Host: mongodb.cn-beijing.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"
}
返回示例 2
{
"ResponseMetadata": {
"RequestId": "202305161612331350F38EC0C05BC25BC2",
"Action": "SwitchDBMaster",
"Version": "2022-01-01",
"Service": "mongodb",
"Region": "cn-beijing"
},
"Result": null
}
请求示例 3
手动切换分片集群实例中 ConfigServer 的主从节点角色。
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=SwitchDBMaster&Version=2022-01-01 HTTP/1.1
Host: mongodb.cn-beijing.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"
}
返回示例 3
{
"ResponseMetadata": {
"RequestId": "202305161612331350F38EC0C05BC25BC2",
"Action": "SwitchDBMaster",
"Version": "2022-01-01",
"Service": "mongodb",
"Region": "cn-beijing"
},
"Result": null
}
错误码
最近更新时间：2026.06.17 15:58:13
这个页面对您有帮助吗？
有用
有用
无用
无用