Call SwitchoverInstance to switch primary and standby instances - ApsaraDB for OceanBase (Deprecated) - Alibaba Cloud - ApsaraDB for OceanBase (Deprecated)

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

oceanbase:SwitchoverInstance

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID of the primary/standby instance. You can set the default value to the instance ID of the instance to be switched to the primary instance.	ob317v4uif****
TargetInstanceId	string	Yes	The instance ID of the instance to be switched to the primary instance.	ob4bv8o7sp****
Forced	boolean	No	Whether to force the switchover. true: Force the switchover. false: Do not force the switchover.	true

Response elements

Element	Type	Description	Example
	object	The returned result of the request.
RequestId	string	The request ID.	473469-AA6F-4D-B3DB-A***********
Data	object	The list of data for the switchover.
Message	string	The message of the switchover.	delete tag-value success
Success	boolean	Whether the switchover is successful. true: the switchover succeeded. false: the switchover failed.	true

Examples

Success response

JSON format

{
  "RequestId": "473469**-AA6F-4D**-B3DB-A***********",
  "Data": {
    "Message": "delete tag-value success",
    "Success": true
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.