SwitchInstanceHA-阿里云帮助中心

Operation description

Note

For a detailed example of connecting applications to the nearest node across multiple availability zones, see Example scenarios.

This operation is supported only on high availability or dual-replica instances.

Calling this operation has the following effects:

During a primary/standby switchover, the affected data node enters a read-only state and experiences a transient connection interruption for several seconds. Ensure your application has a reconnection mechanism.
During an instance switchover, you cannot perform instance-level operations, such as modifying the configuration or performing an availability zone migration.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:SwitchInstanceHA

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID. Call DescribeInstances to obtain the ID.	r-bp1zxszhcgatnx****
NodeId	string	No	The ID of the data shard node. Call DescribeRoleZoneInfo to obtain the value of the CustinsId parameter. Separate multiple node IDs with a comma (,). To specify all nodes, enter `all`. Note This parameter is available and required only for instances that use a cluster or read/write splitting architecture.	56**19,56**20
SwitchMode	integer	No	The time to perform the switchover. Valid values: 0: (Default) The switchover occurs immediately. 1: The switchover occurs within the maintenance window. Note Call the ModifyInstanceMaintainTime operation to change the instance's maintenance window.	0
SwitchType	string	No	The switch mode. Valid values: ReliabilityPriority: (Default) Prioritizes reliability. A primary/standby switchover occurs only when data is fully synchronized between the primary and standby nodes to prevent data loss. In scenarios with high write throughput and persistent synchronization latency, this mode may cause the switchover to fail. AvailablePriority: Prioritizes availability. A primary/standby switchover occurs immediately regardless of synchronization latency. This may result in minor data loss. Note Choose a switch mode based on your business requirements for data consistency and service availability. Valid values: AvailablePriority : AvailablePriority ReliabilityPriority : ReliabilityPriority	ReliabilityPriority

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	5D622714-AEDD-4609-9167-F5DDD3D1****
TaskId	string		674546459

Examples

Success response

JSON format

{
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****",
  "TaskId": "674546459"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.