DescribeAvailableZone - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to query the configurations available for creating an OceanBase cluster.

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
InstanceType	string	Yes	The type of the instance. Enumeration Value: cluster: cluster.	cluster
Series	string	No	The series of the OceanBase cluster. Valid values: normal: Standard Cluster Edition (Cloud Disk). This is the default value. normal_ssd: Standard Cluster Edition (Local Disk). history: History Database Cluster Edition.	normal
DeployType	string	No	The deployment type of the cluster. Valid values: multiple: multi-IDC deployment single: single-IDC deployment dual: dual-IDC deployment	multiple
Spec	string	No	The specification of the node.	oceanbase.cluster.cd8.xlarge
ObVersion	string	No	The version of OceanBase Database.	3.2.4.4
CpuArch	string	No	cpu 架构	x86

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Data	object	The returned data.
AvailableZones	array<object>	The configurations available for cluster creation.
AvailableZones	object	The information about configurations available for cluster creation.
Region	string	The region.	cn-hangzhou
Zones	string	The list of zones.	cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j
Channel	string	The source of the order. PUBLIC FINANCE	PUBLIC
DeployType	string	The deployment type of the cluster. Valid values: multiple: multi-IDC deployment single: single-IDC deployment dual: dual-IDC deployment	multiple
InstanceType	string	The type of the instance.	cluster
Series	string	The series of the OceanBase cluster. Valid values: normal: Standard Cluster Edition (Cloud Disk). This is the default value. normal_ssd: Standard Cluster Edition (Local Disk). history: History Database Cluster Edition.	normal
SupportSpecifications	array<object>	The specifications of the node.
SupportSpecifications	object	The information about specifications of the node.
Spec	string	The specification of the node.	oceanbase.cluster.cd8.xlarge
InstanceClass	string	The specification of the cluster.	4C16GB
DiskTypes	array	The storage types.
DiskTypes	string	The information about storage types.	cloud_essd_pl1
DiskSizeRange	object	The storage size.
Step	long	The minimum adjustment step.	5
Max	long	The maximum value.	40000
Min	long	The minimum value.	1000
SupportEngineVersions	array<object>	The versions.
SupportEngineVersions	object	The information about versions.
ObVersion	string	The version of OceanBase Database.	3.2.4.4
SupportIsolationOptimization	boolean	Indicates whether isolation is supported.	true
SupportReplicaModes	array	The number of full-featured replicas.
SupportReplicaModes	string	The number of full-featured replicas.	3F
CpuArch	string	The CPU architecture.	x86

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Data": {
    "AvailableZones": [
      {
        "Region": "cn-hangzhou",
        "Zones": "cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j",
        "Channel": "PUBLIC",
        "DeployType": "multiple",
        "InstanceType": "cluster",
        "Series": "normal",
        "SupportSpecifications": [
          {
            "Spec": "oceanbase.cluster.cd8.xlarge",
            "InstanceClass": "4C16GB",
            "DiskTypes": [
              "cloud_essd_pl1"
            ],
            "DiskSizeRange": {
              "Step": 5,
              "Max": 40000,
              "Min": 1000
            },
            "SupportEngineVersions": [
              {
                "ObVersion": "3.2.4.4",
                "SupportIsolationOptimization": true,
                "SupportReplicaModes": [
                  "3F"
                ]
              }
            ]
          }
        ],
        "CpuArch": "x86"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-04-15	The request parameters of the API has changed. The response structure of the API has changed	View Change Details