调用SwitchDBInstanceHA接口切换MongoDB实例中的主备节点。

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

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

调试

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

请求参数

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

要执行的操作，取值：SwitchDBInstanceHA。

DBInstanceId String 是 dds-bpxxxxxxxx

实例ID。
RegionId String 否 cn-hangzhou

地域ID，您可以调用DescribeRegions查询。

NodeId String 否 d-bpxxxxxxxx

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

说明 当 DBInstanceId参数传入的是分片集群实例ID时，本参数必须传入。
RoleIds String 否 972xxxx,972xxxx

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

说明
  • 角色ID以英文逗号（,）分隔，不传入本参数则切换主备节点。
  • 当DBInstanceId参数传入的是分片集群实例ID时，执行切换的角色必须属于同一Shard节点中。
SwitchMode Integer 否 0

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

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

返回数据

名称 类型 示例值 描述
RequestId String 26BD4E5F-BDB4-47BA-B232-413AA78CFA8F

请求ID。

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=SwitchDBInstanceHA
&DBInstanceId=dds-bpxxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式 

<SwitchDBInstanceHAResponse>
	  <RequestId>26BD4E5F-BDB4-47BA-B232-413AA78CFA8F</RequestId>
</SwitchDBInstanceHAResponse>

JSON 格式 

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

错误码

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