DescribeDBClusterAvailableResources - PolarDB - Alibaba Cloud Documentation Center

Queries available resources in a PolarDB 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
PayType	string	Yes	The billing method of the cluster. Valid values: Postpaid: pay-as-you-go Prepaid: subscription	Postpaid
DBType	string	No	The type of the database engine. Valid values: MySQL PostgreSQL Oracle	MySQL
DBVersion	string	No	The version of the database engine. Valid values for the MySQL database engine: 5.6 5.7 8.0 Valid values for the PostgreSQL database engine: 11 14 Valid value for the Oracle database engine: 11 Note This parameter is required when you specify the DBType parameter.	5.6
DBNodeClass	string	No	The specifications of the node. For more information, see Specifications of compute nodes.	polar.mysql.x4.large
RegionId	string	No	The region ID of the cluster. Default value: cn-hangzhou. Note You can call the DescribeRegions operation to query the available regions.	cn-hangzhou
ZoneId	string	No	The zone ID of the cluster. Note You can call the DescribeRegions operation to query the available zones.	cn-hangzhou-i

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	2B19F698-8FFC-4918-B9E2-58D878******
AvailableZones	array<object>	The available zones of the cluster.
AvailableZone	object
SupportedEngines	array<object>	The database engines that the available resources support.
SupportedEngine	object
Engine	string	The version of the database engine.	mysql57
AvailableResources	array<object>	The available resources.
AvailableResource	object
DBNodeClass	string	The specifications of the node.	polar.mysql.x4.large
Category	string	The edition of the cluster. Valid values: Normal: Cluster Edition. Basic: Single Node Edition. ArchiveNormal: X-Engine. NormalMultimaster: Multi-master Cluster (Database/Table) Edition. SENormal: Standard Edition. Note Only PolarDB for MySQL supports Single Node Edition. Only PolarDB for MySQL 8.0 supports X-Engine Edition and Multi-master Cluster (Database/Table) Edition.	Normal
ZoneId	string	The zone ID of the cluster.	cn-hangzhou-i
RegionId	string	The region ID of the cluster.	cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "RequestId": "2B19F698-8FFC-4918-B9E2-58D878******",
  "AvailableZones": [
    {
      "SupportedEngines": [
        {
          "Engine": "mysql57",
          "AvailableResources": [
            {
              "DBNodeClass": "polar.mysql.x4.large",
              "Category": "Normal"
            }
          ]
        }
      ],
      "ZoneId": "cn-hangzhou-i",
      "RegionId": "cn-hangzhou"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBVersion.Malformed	The Specified DBVersion is not valid.	The specified DBVersion parameter is invalid.

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

Change history

Change time	Summary of changes	Operation
2022-11-24	The Error code has changed	View Change Details