All Products
Search
Document Center

ApsaraDB for OceanBase:SwitchoverInstance

Last Updated:Dec 02, 2024

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
oceanbase:SwitchoverInstanceupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

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****
TargetInstanceIdstringYes

The instance ID of the instance to be switched to the primary instance.

ob4bv8o7sp****
ForcedbooleanNo

Whether to force the switchover.

  • true: Force the switchover.
  • false: Do not force the switchover.
true

Response parameters

ParameterTypeDescriptionExample
object

The returned result of the request.

RequestIdstring

The request ID.

473469**-AA6F-4D**-B3DB-A***********
Dataobject

The list of data for the switchover.

Messagestring

The message of the switchover.

delete tag-value success
Successboolean

Whether the switchover is successful.

  • true: the switchover succeeded.
  • false: the switchover failed.
true

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history