Performs a master-replica switchover to switch node roles. This operation is applicable to disaster recovery drills and nearby access to applications that are deployed across zones.
Operation description
The instance must be an ApsaraDB for Redis Community Edition instance or Enhanced Edition (Tair) DRAM-based instance that uses local disks.
A call to this operation has the following impacts on your instance:
- The data shards in the instance may change to the read-only state and experience transient connections within seconds. Make sure that your application is configured to automatically reconnect to the instance.
- If the instance enters the switching state, you cannot manage this instance. For example, you cannot modify the instance configurations or migrate the instance to another zone.
Debugging
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 Resourcesis 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 |
|---|---|---|---|---|
| kvstore:SwitchInstanceHA | update | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The ID of the instance. You can call the DescribeInstances operation to query the ID of the instance. | r-bp1zxszhcgatnx**** |
| NodeId | string | No | The ID of the data shard. You can call the DescribeRoleZoneInfo operation to obtain the value of the CustinsId parameter. Separate multiple data shard IDs with commas (,). Note
This parameter is available and required only for read/write splitting and cluster instances.
| 56****19,56****20 |
| SwitchMode | integer | No | The time when to perform the switchover. Default value: 0. Valid values:
Note
You can call the ModifyInstanceMaintainTime operation to modify the maintenance window of an ApsaraDB for Redis instance.
| 0 |
| SwitchType | string | Yes | The switching mode. Valid values:
Note
You must evaluate the requirements for data and services based on your business scenarios and then select a switching mode.
| AvailablePriority |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-07-20 | API Description Update | View Change Details |