All Products
Search
Document Center

ApsaraDB for OceanBase:ModifyTenantPrimaryZone

Last Updated:Dec 02, 2024

You can call this operation to switch the primary zone of the tenant.

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:ModifyTenantPrimaryZoneupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TenantIdstringYes

The return result of the request.

ob2mr3oae0****
InstanceIdstringYes

The primary zone of the tenant.
It is one of the zones in which the cluster is deployed.

ob317v4uif****
PrimaryZonestringYes

The ID of the vSwitch.

cn-hangzhou-h
UserVSwitchIdstringNo

The request ID.

vsw-xxx
ModifyTypestringNo

The switching mode.

Enumeration Value:
  • AllLink
  • Temporary
AllLink
PrimaryZoneDeployTypestringNo

Example 1

Enumeration Value:
  • RANDOM
  • STATIC
RANDOM
MasterIntranetAddressZonestringNo
http(s)://[Endpoint]/?Action=ModifyTenantPrimaryZone
&TenantId=ob2mr3oae0****
&InstanceId=ob317v4uif****
&PrimaryZone=cn-hangzhou-h
&Common request parameters
cn-hangzhou-h

Response parameters

ParameterTypeDescriptionExample
object

You can call this operation to switch the primary zone of the tenant.

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-04-15The request parameters of the API has changedView Change Details
2024-02-02The request parameters of the API has changedView Change Details
2023-12-26The request parameters of the API has changedView Change Details
2023-07-04The request parameters of the API has changedView Change Details
2022-09-28The request parameters of the API has changedView Change Details