All Products
Search

This Product

    PolarDB:DescribeClassList

    Document Center

    PolarDB:DescribeClassList

    Last Updated:Dec 11, 2025

    Lists the available cluster specifications.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    polardb:DescribeClassList

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    MasterHa

    string

    No

    The number of nodes. Valid values:

    • single: single node.

    • cluster: cluster.

    • all: single node and cluster.

    cluster
    ResourceGroupId

    string

    No

    The ID of the resource group.

    rg-************
    CommodityCode

    string

    Yes

    The commodity code. Valid values:

    • polardb_sub: subscription for the Chinese mainland.

    • polardb_sub_intl: subscription for regions in Hong Kong (China) and outside the Chinese mainland.

    • polardb_payg: pay-as-you-go for the Chinese mainland.

    • polardb_payg_intl: pay-as-you-go for regions in Hong Kong (China) and outside the Chinese mainland.

    • polardb_sub_jushita: Jushita subscription.

    • polardb_payg_jushita: Jushita pay-as-you-go.

    • polardb_sub_cainiao: Cainiao subscription.

    • polardb_payg_cainiao: Cainiao pay-as-you-go.

    Note

    • If you use an Alibaba Cloud China site account, you can view only the commodity codes for the Chinese mainland.

    • If you use an Alibaba Cloud international site account, you can view only the commodity codes for regions outside the Chinese mainland.

    • If you use a Jushita account, you can view only the commodity codes for Jushita.

    • If you use a Cainiao account, you can view only the commodity codes for Cainiao.

    polardb_sub
    OrderType

    string

    No

    The order type. Valid values:

    • BUY: new purchase.

    • UPGRADE: changes the configuration.

    • RENEW: renews the instance.

    • CONVERT: changes the billing method.

    BUY
    RegionId

    string

    No

    The region ID.

    Note

    This parameter is required if you use an Alibaba Cloud international site account.

    cn-hangzhou

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    69A85BAF-1089-4CDF-A82F-0A140F******
    Items

    array<object>

    The list of cluster specifications.

    object

    Psl4MaxIOPS

    string

    The maximum input/output operations per second (IOPS) of PSL4. Unit: IOPS.

    48000
    ClassTypeLevel

    string

    The specification type.

    enterprise
    Cpu

    string

    The number of CPU cores. Unit: cores.

    8
    ReferencePrice

    string

    The price.

    Unit: cents (USD).

    Note

    • If you set the CommodityCode parameter to a pay-as-you-go commodity code, the hourly price is returned.

    • If you set the CommodityCode parameter to a subscription commodity code, the monthly price is returned.

    200000
    ReferenceExtPrice

    string

    The additional price.

    Unit: cents (USD).

    Note

    • If you set the MasterHa parameter to cluster or single, the value of this parameter is the same as the value of the ReferencePrice parameter.

    • If you set the MasterHa parameter to cluster or single, the price for a single-node commodity is returned.

    200000
    MaxConnections

    string

    The maximum number of concurrent connections to the cluster.

    8000
    MemoryClass

    string

    The memory capacity. Unit: GB.

    32
    ClassCode

    string

    The cluster specifications.

    polar.mysql.x4.medium
    ClassGroup

    string

    The family of the cluster specifications. Valid values:

    • Exclusive package

    • Exclusive physical machine

    • Beginner

    • Historical specifications

    Exclusive package
    Psl5MaxIOPS

    string

    The maximum IOPS of PSL5. Unit: IOPS.

    96000
    MaxIOPS

    string

    The maximum IOPS. Unit: IOPS.

    32000
    MaxStorageCapacity

    string

    The maximum storage capacity. Unit: TB.

    20
    Pl1MaxIOPS

    string

    The maximum IOPS of an Enhanced SSD (ESSD) at performance level 1 (PL1). Unit: IOPS.

    50000
    Pl2MaxIOPS

    string

    The maximum IOPS of an ESSD at PL2. Unit: IOPS.

    100000
    Pl3MaxIOPS

    string

    The maximum IOPS of an ESSD at PL3. Unit: IOPS.

    1000000
    EssdMaxStorageCapacity

    string

    The maximum storage capacity of an ESSD. Unit: TB.

    64
    PolarStoreMaxStorageCapacity

    string

    The maximum storage capacity of PSL4/PSL5. Unit: TB.

    500
    RegionId

    string

    The region ID.

    cn-hangzhou

    Examples

    Success response

    JSON format

    {
  "RequestId": "69A85BAF-1089-4CDF-A82F-0A140F******",
  "Items": [
    {
      "Psl4MaxIOPS": "48000",
      "ClassTypeLevel": "enterprise",
      "Cpu": "8",
      "ReferencePrice": "200000",
      "ReferenceExtPrice": "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",
      "EssdMaxStorageCapacity": "64",
      "PolarStoreMaxStorageCapacity": "500"
    }
  ],
  "RegionId": "cn-hangzhou"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameters.Format Specified parameters is not valid. The specified parameters are invalid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.