SwitchoverInstance - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to switch between the primary and standby instances of OceanBase.

Debugging

There is currently no authorization information disclosed in the API.

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

Parameter	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

Sample success responses

JSONformat

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

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

Change time	Summary of changes	Operation

No change history