Queries the available resources of a specified PolarDB cluster.
Debugging
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:
|
DBType | String | No | MySQL |
The type of the database engine. Valid values:
|
DBVersion | String | No | 5.6 |
The version number of the database engine.
|
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 PolarDB cluster. Default value: cn-hangzhou. Note You can call the DescribeRegions operation to query available regions.
|
ZoneId | String | No | cn-hangzhou-i |
The zone ID of the available node. Note You can call the DescribeRegions operation to query available zones.
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
AvailableZones | Array of AvailableZone |
The list of available resources. |
|
RegionId | String | cn-hangzhou |
The region ID of the PolarDB cluster. |
SupportedEngines | Array of SupportedEngine |
The list of available engines. |
|
AvailableResources | Array of AvailableResource |
The list of available resources. |
|
Category | String | Normal |
The edition of the cluster. Valid values:
|
DBNodeClass | String | polar.mysql.x4.large |
The specification of the available node. |
Engine | String | mysql57 |
The version of the database engine. |
ZoneId | String | cn-hangzhou-i |
The zone ID of the available node. |
RequestId | String | 2B19F698-8FFC-4918-B9E2-58D878****** |
The ID of the request. |
Examples
Sample requests
http(s)://polardb.aliyuncs.com/? Action=DescribeDBClusterAvailableResources
&PayType=Postpaid
&<Common request parameters>
Sample success responses
XML
format
<RequestId>5D070B24-40C5-4077-B526-DC1A03******</RequestId>
<AvailableZones>
<ZoneId>cn-hangzhou-h</ZoneId>
<RegionId>cn-hangzhou</RegionId>
<SupportedEngines>
<AvailableResources>
<Category>Normal</Category>
<DBNodeClass>polar.mysql.x4.large</DBNodeClass>
</AvailableResources>
<Engine>mysql57</Engine>
</SupportedEngines>
</AvailableZones>
JSON
format
{
"RequestId": "2B19F698-8FFC-4918-B9E2-58D878******",
"AvailableZones": [
{
"ZoneId": "cn-hangzhou-i",
"RegionId": "cn-hangzhou",
"SupportedEngines": [
{
"AvailableResources": [
{
"Category": "Normal",
"DBNodeClass": "polar.mysql.x4.large"
},
{
"Category": "Normal",
"DBNodeClass": "polar.mysql.x4.xlarge"
},
{
"Category": "Normal",
"DBNodeClass": "polar.mysql.x8.xlarge"
},
{
"Category": "Normal",
"DBNodeClass": "polar.mysql.x8.2xlarge"
},
{
"Category": "Normal",
"DBNodeClass": "polar.mysql.x8.4xlarge"
},
{
"Category": "Normal",
"DBNodeClass": "polar.mysql.x8.8xlarge"
},
{
"Category": "Normal",
"DBNodeClass": "polar.mysql.x8.12xlarge"
},
{
"Category": "Normal",
"DBNodeClass": "polar.mysql.x4.medium"
},
{
"Category": "basic",
"DBNodeClass": "polar.mysql.s2.large"
}
],
"Engine": "MySQL8.0"
}
]
}
]
}
Error codes
For a list of error codes, visit the API Error Center.