调用DescribeDBClusterAvailableResources接口查询PolarDB集群可售卖资源。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBClusterAvailableResources

系统规定参数。取值:DescribeDBClusterAvailableResources

PayType String Postpaid

付费类型,取值范围如下:

  • Postpaid:按量付费(也称后付费或按小时付费)。
  • Prepaid:包年包月(也称预付费)。
DBType String MySQL

数据库引擎类型,取值范围如下:

  • MySQL
  • PostgreSQL
  • Oracle
DBVersion String 5.6

数据库引擎版本号。

MySQL版本号取值范围如下:

  • 5.6
  • 5.7
  • 8.0

PostgreSQL版本号取值范围如下:

  • 11
  • 14

Oracle版本号取值为11

说明 当传入DBType参数时,该参数必填。
DBNodeClass String polar.mysql.x4.large

节点规格,详情请参见计算节点规格

RegionId String cn-hangzhou

地域ID。默认为cn-hangzhou

说明 可通过接口DescribeRegions查看可用的地域。
ZoneId String cn-hangzhou-i

可用区ID。

说明 可通过DescribeRegions查看可用区。

返回数据

名称 类型 示例值 描述
RequestId String 2B19F698-8FFC-4918-B9E2-58D878******

请求ID。

AvailableZones Array of AvailableZone

可售卖的资源信息列表。

SupportedEngines Array of SupportedEngine

可售卖引擎列表。

Engine String mysql57

数据库引擎版本。

AvailableResources Array of AvailableResource

可售卖的资源列表。

DBNodeClass String polar.mysql.x4.large

节点规格。

Category String Normal

集群系列,取值范围如下:

  • Normal:集群版
  • basic:单节点
  • archive:高压缩引擎(X-Engine)
  • NormalMultimaster:多主集群(库表)
    说明
    • 仅PolarDB MySQL引擎支持单节点产品系列。
    • 仅PolarDB MySQL引擎8.0版本的集群,支持高压缩引擎(X-Engine)和多主集群(库表)系列。
ZoneId String cn-hangzhou-i

可用区ID。

RegionId String cn-hangzhou

地域ID。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeDBClusterAvailableResources
&PayType=Postpaid
&DBType=MySQL
&DBVersion=5.6
&DBNodeClass=polar.mysql.x4.large
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-i
&<公共请求参数>

正常返回示例

XML格式

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格式

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"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidDBVersion.Malformed The Specified DBVersion is not valid. 指定的DBVersion无效

访问错误中心查看更多错误码。