Call DescribeAvailableZone to query available cluster configurations - ApsaraDB for OceanBase (Deprecated) - Alibaba Cloud - ApsaraDB for OceanBase (Deprecated)

Queries the available configurations on the purchase page for an OceanBase cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceType	string	Yes	The instance type. Valid values: cluster : cluster	cluster
Series	string	No	The series.	normal
DeployType	string	No	The deployment plan.	multiple
Spec	string	No	The node plan.	oceanbase.cluster.cd8.xlarge
ObVersion	string	No	The OceanBase version number.	3.2.4.4
CpuArch	string	No	The CPU architecture.	x86

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Data	object	The returned data.
AvailableZones	array<object>	The zone information.
	array<object>	The zone list information.
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.
	array<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.
	string	The information about storage types.	cloud_essd_pl1
DiskSizeRange	object	The storage size.
Step	integer	The minimum adjustment step.	5
Max	integer	The maximum value.	40000
Min	integer	The minimum value.	1000
SupportEngineVersions	array<object>	The versions.
	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.
	string	The number of full-featured replicas.	3F
CpuArch	string	The CPU architecture.	x86

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.