DescribeDBClusterAvailableResources - PolarDB - Alibaba Cloud Documentation Center

Operation description

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
PayType	string	Yes	The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Postpaid
DBType	string	No	The database engine type. Valid values: MySQL PostgreSQL Oracle	MySQL
DBVersion	string	No	The version of the database engine. Valid values for MySQL: 5.6 5.7 8.0 Valid values for PostgreSQL: 11 14 Valid values for Oracle: 11 14 Note This parameter is required if you specify the DBType parameter.	5.6
DBNodeClass	string	No	The node specifications. For more information, see Compute node specifications.	polar.mysql.x4.large
RegionId	string	No	The region ID. The default value is cn-hangzhou. Note Call the DescribeRegions operation to view available regions.	cn-hangzhou
ZoneId	string	No	The zone ID. Note Call the DescribeRegions operation to view available zones.	cn-hangzhou-i

Response elements

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

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.