All Products
Search
Document Center

PolarDB:DescribeClassList

Last Updated:Jun 17, 2024

Queries the specifications of a cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
polardb:DescribeClassListRead
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
MasterHastringNo

The number of nodes. Valid values:

  • single: Standalone Edition.
  • cluster: Cluster Edition.
  • all: both Standalone Edition and Cluster Edition.
cluster
ResourceGroupIdstringNo

The ID of the resource group.

rg-************
CommodityCodestringYes

The code of the commodity. 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
Note
  • If you use an Alibaba Cloud account on the China site, you can view only the codes of the commodities that are available in the Chinese mainland.
  • If you are using an Alibaba Cloud international account, you can view only the codes of the commodities that are available outside the Chinese mainland.
  • If you use a CloudTmall account, you can view only the codes of the commodities that are available in CloudTmall.
  • If you use a Cainiao account, you can view only the codes of the commodities that are available in Cainiao.
  • polardb_sub
    OrderTypestringNo

    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.
    BUY
    RegionIdstringNo

    The region ID of the cluster.

    cn-hangzhou

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    69A85BAF-1089-4CDF-A82F-0A140F******
    Itemsobject []

    The specifications of the cluster.

    Psl4MaxIOPSstring

    The maximum Input/output operations per second (IOPS) for PolarStore Level 4 (PSL4). Unit: operations per second.

    48000
    ClassTypeLevelstring

    The specification type of the cluster.

    enterprise
    Cpustring

    The number of vCPU cores. Unit: cores.

    8
    ReferencePricestring

    The price.

    Unit: cents (USD).

    Note
  • If you set CommodityCode to a commodity that uses the pay-as-you-go billing method, ReferencePrice indicates the hourly fee that you need to pay.
  • If you set CommodityCode to a commodity that uses the subscription billing method, ReferencePrice indicates the monthly fee that you need to pay.
  • 200000
    ReferenceExtPricestring

    The additional price.

    Unit: cents (USD).

    Note
  • If you set MasterHa to cluster or single, the value of ReferenceExtPrice is the same as the value of ReferencePrice.
  • If you set MasterHa to cluster or single, the value of ReferenceExtPrice is the price of the single-node cluster.
  • 200000
    MaxConnectionsstring

    The maximum number of concurrent connections in the cluster.

    8000
    MemoryClassstring

    The memory size. Unit: GB.

    32
    ClassCodestring

    The specifications of the cluster.

    polar.mysql.x4.medium
    ClassGroupstring

    The instance family of the cluster. Valid values:

    • Exclusive package: dedicated
    • Exclusive physical machine: dedicated host
    • Beginner: starter
    • Historical specifications: historical
    Exclusive package
    Psl5MaxIOPSstring

    The maximum IOPS for PolarStore Level 5 (PSL5). Unit: operations per second.

    96000
    MaxIOPSstring

    The maximum IOPS. Unit: operations per second.

    32000
    MaxStorageCapacitystring

    The maximum storage capacity. Unit: TB.

    20
    Pl1MaxIOPSstring

    The maximum IOPS of an enhanced SSD (ESSD) of performance level 1 (PL1). Unit: operations per second.

    50000
    Pl2MaxIOPSstring

    The maximum IOPS of an ESSD of performance level 2 (PL2). Unit: operations per second.

    100000
    Pl3MaxIOPSstring

    The maximum IOPS of an ESSD of performance level 3 (PL3). Unit: operations per second.

    1000000
    RegionIdstring

    The region ID of the cluster.

    cn-hangzhou

    Examples

    Sample success responses

    JSONformat

    {
      "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"
        }
      ],
      "RegionId": "cn-hangzhou"
    }

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidParameters.FormatSpecified parameters is not valid.The specified parameters are invalid.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-06-27The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Added Error Codes: 400
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: MasterHa
    Output ParametersThe response structure of the API has changed.
    2022-12-27The response structure of the API has changedsee changesets
    Change itemChange content
    Output ParametersThe response structure of the API has changed.
    2022-09-08Add Operationsee changesets