SwitchDBInstanceHA - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Switches the primary and secondary nodes for an ApsaraDB for MongoDB instance.

Operation description

The instance must be running when you call this operation.

Note

This operation is applicable to replica set instances and sharded cluster instances, but cannot be performed on standalone instances.
On replica set instances, the switch is performed between instances. On sharded cluster instances, the switch is performed between shards.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dds:SwitchDBInstanceHA	none	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance	dds-bpxxxxxxxx
NodeId	string	No	The ID of the shard node in the sharded cluster instance. Note You must specify this parameter if you set the DBInstanceId parameter to the ID of a sharded cluster instance.	d-bpxxxxxxxx
RoleIds	string	No	The IDs of the roles who switch the primary and secondary nodes for the instance. You can call the DescribeRoleZoneInfo operation to view the IDs and information of roles of nodes. Note Separate role IDs with commas (,). If this parameter is not specified, the primary and secondary nodes are switched. If you set the DBInstanceId parameter to the ID of a sharded cluster instance, the roles who switch the primary and secondary nodes for the instance must belong to one shard node.	972xxxx,972xxxx
SwitchMode	integer	No	The time when the primary and secondary nodes are switched. Valid values: 0: The primary and secondary nodes are immediately switched. 1: The primary and secondary nodes are switched during the O&M time period.	0

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	26BD4E5F-BDB4-47BA-B232-413AA78CFA8F

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message
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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-07-13	The Error code has changed	View Change Details