DescribeTenantZonesRead - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to query the information about read-only zones of a 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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The zone information of the tenant.	ob317v4uif****
TenantId	string	Yes	The return result of the request.	ob2mr3oae0****

Response parameters

Parameter	Type	Description	Example
	object	Indicates whether a read-only connection has been created.
RequestId	string	Indicates whether a read-only connection needs to be created for the zone.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
TenantZones	array<object>	The request ID.
TenantZones	object	The operation that you want to perform. Set the value to DescribeTenantZonesRead.
IsElectable	boolean	Example 1	true
IsPrimary	boolean		true

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "TenantZones": [
    {
      "IsElectable": true,
      "IsPrimary": true,
      "Zone": "cn-hangzhou-i",
      "IsReadOnlyAddressMaster": true,
      "IsReadable": true
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-07-04	The response structure of the API has changed	View Change Details