Queries PolarDB resources that are available.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. 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 Yes DescribeDBClusterAvailableResources

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

PayType String Yes Postpaid

The billing method. Valid values:

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

The database engine. Valid values:

  • MySQL
  • PostgreSQL
  • Oracle
DBVersion String No 5.6

The version number of the database engine

  • Valid values for the MySQL database engine:
    • 5.6
    • 5.7
    • 8.0
  • Valid value for the PostgreSQL database engine: 11
  • Valid value for the Oracle database engine: 11
Note If you specify the DBType parameter, you must specify this parameter.
DBNodeClass String No polar.mysql.x4.large

The node type. For more information, see Specifications of compute nodes.

RegionId String No cn-hangzhou

The ID of the region where PolarDB resources that you want to query reside. Default value: cn-hangzhou.

Note You can call the DescribeRegions operation to query information about regions.
ZoneId String No cn-hangzhou-i

The ID of the zone where PolarDB resources that you want to query reside.

Note You can call the DescribeRegions operation to query information about zones.

Response parameters

Parameter Type Example Description
RequestId String 2B19F698-8FFC-4918-B9E2-58D878******

The ID of the request.

AvailableZones Array of AvailableZone

The information about the PolarDB resources that are available.

SupportedEngines Array of SupportedEngine

The database engines that the available resources support.

Engine String mysql57

The version of the database engine.

AvailableResources Array of AvailableResource

The list of available resources.

DBNodeClass String polar.mysql.x4.large

The node type.

Category String Normal

The edition of clusters that are available. Valid values:

  • Normal: Cluster Edition
  • Basic: Single Node Edition
  • Archive: Archive Database Edition
ZoneId String cn-hangzhou-i

The ID of the zone where the type of available resources reside.

RegionId String cn-hangzhou

The ID of the region where the type of available resources reside.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/?Action=DescribeDBClusterAvailableResources
&PayType=Postpaid
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBClusterAvailableResourcesResponse>
    <RequestId>2B19F698-8FFC-4918-B9E2-58D878******</RequestId>
    <AvailableZones>
        <SupportedEngines>
            <Engine>mysql57</Engine>
            <AvailableResources>
                <DBNodeClass>polar.mysql.x4.large</DBNodeClass>
                <Category>Normal</Category>
            </AvailableResources>
        </SupportedEngines>
        <ZoneId>cn-hangzhou-i</ZoneId>
        <RegionId>cn-hangzhou</RegionId>
    </AvailableZones>
</DescribeDBClusterAvailableResourcesResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

HttpCode Error code Error message Description
400 InvalidEngineVersion.Malformed The specified parameter EngineVersion is not valid. The error code returned because the specified value for the DBVersion parameter is invalid.

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