You can call this operation to query available resources of an Apsara PolarDB cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No DescribeDBClusterAvailableResources

The operation that you want to perform. Set the value to DescribeDBClusterAvailableResources.

PayType String Yes Postpaid

The billing method. Valid values:

  • Postpaid: pay-as-you-go
  • Prepaid: subscription
DBType String No MySQL

The engine of the database that you want to manage. Valid values:

  • MySQL
  • PostgreSQL
  • Oracle
DBVersion String No 5.6

The version of the database engine.

Valid values for MySQL:

  • 5.6
  • 8.0

Valid values for PostgreSQL:

  • 11

Valid values for Oracle:

  • 11
DBNodeClass String No polar.mysql.x4.large

The specification of the available node. For more information, see Specifications and pricing.

RegionId String No cn-hangzhou

The region ID of the Apsara PolarDB cluster.

Note You can call the DescribeRegions operation to query the most recent region list.
ZoneId String No cn-hangzhou-i

The zone ID of the available node.

Note You can call the DescribeRegions operation to query the most recent zone list.

Response parameters

Parameter Type Example Description
RequestId String 47510E32-E16C-4561-A380-4EBFC667716F

The ID of the request.

AvailableZones Array

The list of available resources.

RegionId String cn-hangzhou

The region ID of the Apsara PolarDB cluster.

ZoneId String cn-hangzhou-i

The zone ID of the available node.

SupportedEngines Array

The list of available engines.

Engine String MySQL5.6

The version of the database engine.

AvailableResources Array

The list of available resources.

DBNodeClass String polar.mysql.x4.large

The specification of the available node.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeDBClusterAvailableResources
&PayType=Postpaid
&<Common request parameters>

Sample success responses

XML format

<RequestId>47510E32-E16C-4561-A380-4EBFC667716F</RequestId>
<AvailableZones>
    <RegionId>cn-hangzhou</RegionId>
    <ZoneId>cn-hangzhou-i</ZoneId>
    <SupportedEngines>
        <AvailableResources>
            <DBNodeClass>polar.mysql.x4.large</DBNodeClass>
        </AvailableResources>
        <Engine>MySQL5.6</Engine>
    </SupportedEngines>
</AvailableZones>

JSON format

{
    "RequestId": "47510E32-E16C-4561-A380-4EBFC667716F",
    "AvailableZones": [
        {
            "RegionId": "cn-hangzhou",
            "ZoneId": "cn-hangzhou-i",
            "SupportedEngines": [
                {
                    "AvailableResources": [
                        {
                            "DBNodeClass": "polar.mysql.x4.large"
                        }
                    ],
                    "Engine": "MySQL5.6"
                }
            ]
        }
    ]
}

Error codes

For a list of error codes, visit the API Error Center.