Queries the list of cluster specifications.

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 Yes DescribeClassList

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

ResourceGroupId String No rg-************

The ID of the resource group.

CommodityCode String Yes polardb_sub

The commodity code. Valid values:

  • polardb_sub: the subscription cluster in regions in the Chinese mainland
  • polardb_sub _intl: the subscription cluster in regions outside the Chinese mainland
  • polardb_payg: the pay-as-you-go cluster in regions in the Chinese mainland
  • polardb_payg_intl: the pay-as-you-go cluster in regions outside the Chinese mainland
  • polardb_sub_jushita: the subscription cluster for CloudTmall
  • polardb_payg_jushita: the pay-as-you-go cluster for CloudTmall
  • polardb_sub_cainiao: the subscription cluster for Cainiao
  • polardb_payg_cainiao: the pay-as-you-go cluster for Cainiao
OrderType String No BUY

The type of the order. Valid values:

  • BUY: the order is used to purchase a cluster.
  • UPGRADE: the order is used to change the specifications of a cluster.
  • RENEW: the order is used to renew a cluster.
  • CONVERT: the order is used to change the billing method of a cluster.
RegionId String No cn-hangzhou

The region ID of the cluster.

Note If you are using an Alibaba Cloud account on the International site (alibabacloud.com), you must specify this parameter.

Response parameters

Parameter Type Example Description
RequestId String 69A85BAF-1089-4CDF-A82F-0A140F******

The ID of the request.

Items Array of Items
Psl4MaxIOPS String 48000

The maximum number of IOPS.

ClassTypeLevel String enterprise

The specification type of the cluster.

Cpu String 8

The number of CPU cores.

ReferencePrice String 200000

The price.

Unit: cents (US dollars).

Note
  • If you set the CommodityCode parameter to a value that indicates the pay-as-you-go billing method, the ReferencePrice parameter specifies the hourly fee that you must pay.
  • If you set the CommodityCode parameter to a value that indicates the subscription billing method, the ReferencePrice parameter specifies the monthly fee that you must pay.
MaxConnections String 8000

The maximum number of concurrent connections in the cluster.

MemoryClass String 32

The memory size. Unit: GB.

ClassCode String polar.mysql.x4.medium

The specifications of the cluster.

ClassGroup String Exclusive package

The instance family of the cluster.

  • Exclusive package: dedicated
  • Exclusive physical machine: dedicated host
  • Beginner: starter
  • Historical specifications: historical
Psl5MaxIOPS String 96000

The maximum IOPS of PSL5.

MaxIOPS String 32000

The maximum IOPS.

MaxStorageCapacity String 20

The maximum storage capacity. Unit: TB.

Pl1MaxIOPS String 50000

The maximum IOPS of an ESSD of PL1.

Pl2MaxIOPS String 100000

The maximum IOPS of an ESSD of PL2.

Pl3MaxIOPS String 1000000

The maximum IOPS of an ESSD of PL3.

RegionId String cn-hangzhou

The region ID of the cluster.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/?Action=DescribeClassList
&ResourceGroupId=rg-************
&CommodityCode=polardb_sub
&OrderType=BUY
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

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

<DescribeClassListResponse>
    <RequestId>69A85BAF-1089-4CDF-A82F-0A140F******</RequestId>
    <Items>
        <Psl4MaxIOPS>48000</Psl4MaxIOPS>
        <ClassTypeLevel>enterprise</ClassTypeLevel>
        <Cpu>8</Cpu>
        <ReferencePrice>200000</ReferencePrice>
        <MaxConnections>8000</MaxConnections>
        <MemoryClass>32</MemoryClass>
        <ClassCode>polar.mysql.x4.medium</ClassCode>
        <ClassGroup>Exclusive package</ClassGroup>
        <Psl5MaxIOPS>96000</Psl5MaxIOPS>
        <MaxIOPS>32000</MaxIOPS>
        <MaxStorageCapacity>20</MaxStorageCapacity>
        <Pl1MaxIOPS>50000</Pl1MaxIOPS>
        <Pl2MaxIOPS>100000</Pl2MaxIOPS>
        <Pl3MaxIOPS>1000000</Pl3MaxIOPS>
    </Items>
    <RegionId>cn-hangzhou</RegionId>
</DescribeClassListResponse>

JSON format

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

{
  "RequestId" : "69A85BAF-1089-4CDF-A82F-0A140F******",
  "Items" : [ {
    "Psl4MaxIOPS" : "48000",
    "ClassTypeLevel" : "enterprise",
    "Cpu" : "8",
    "ReferencePrice" : "200000",
    "MaxConnections" : "8000",
    "MemoryClass" : "32",
    "ClassCode" : "polar.mysql.x4.medium",
    "ClassGroup" : "Exclusive package",
    "Psl5MaxIOPS" : "96000",
    "MaxIOPS" : "32000",
    "MaxStorageCapacity" : "20",
    "Pl1MaxIOPS" : "50000",
    "Pl2MaxIOPS" : "100000",
    "Pl3MaxIOPS" : "1000000"
  } ],
  "RegionId" : "cn-hangzhou"
}

Error codes

For a list of error codes, see Service error codes.