Switches the primary and secondary nodes for instance.
Operation Description
The instance must be in the running state when you call this operation.
Authorization information
The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action
Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:
- 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 keyword: refers to the condition keyword defined by the cloud product itself.
- 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.
Operate | access level | Resource type | conditional keyword | Association operation |
---|---|---|---|---|
dds:SwitchDBInstanceHA | WRITE |
|
|
without |
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 in the sharded cluster instance.
Note
You must specify this parameter if the value of DBInstanceId is the ID of a sharded cluster instance.
|
d-bpxxxxxxxx |
RoleIds | string | No |
The IDs of the roles that you want to switch. You can call the DescribeRoleZoneInfo operation to query IDs of roles and roles of nodes.
Note
|
972xxxx,972xxxx |
SwitchMode | integer | No |
The time when roles of the primary and secondary nodes are switched. Valid values:
|
0 |
Response parameters
Example
Normal return example
JSON
Format
{
"RequestId": "26BD4E5F-BDB4-47BA-B232-413AA78CFA8F"
}
Error codes
Http 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 API error center.