All Products
Search

This Product

    PolarDB:DescribeDBClusterAvailableResources

    Document Center

    PolarDB:DescribeDBClusterAvailableResources

    Last Updated:Jun 10, 2026

    Queries the available resources of a PolarDB cluster.

    Operation description

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    PayType

    string

    Yes

    The billing method. Valid values:

    • Postpaid: pay-as-you-go (also known as postpaid or hourly billing).

    • Prepaid: subscription (also known as prepaid).

    Postpaid
    DBType

    string

    No

    The type of the database engine. Valid values:

    • MySQL

    • PostgreSQL

    • Oracle

    MySQL
    DBVersion

    string

    No

    The version of the database engine. Valid values for MySQL:

    • 5.6

    • 5.7

    • 8.0

    Valid values for PostgreSQL:

    • 11

    • 14

    Valid values for Oracle:

    • 11

    • 14

    Note

    This parameter is required when the DBType parameter is specified.

    5.6
    DBNodeClass

    string

    No

    The specifications of the node. For more information, see Specifications of compute nodes.

    polar.mysql.x4.large
    RegionId

    string

    No

    The region ID. The default value is cn-hangzhou.

    Note

    You can call the DescribeRegions operation to query the available regions.

    cn-hangzhou
    ZoneId

    string

    No

    The zone ID.

    Note

    You can call the DescribeRegions operation to query the available zones.

    cn-hangzhou-i

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    2B19F698-8FFC-4918-B9E2-58D878******
    AvailableZones

    array<object>

    The list of available resources.

    array<object>

    SupportedEngines

    array<object>

    The list of available engines.

    array<object>

    Engine

    string

    The version of the database engine.

    mysql57
    AvailableResources

    array<object>

    The available resources.

    object

    DBNodeClass

    string

    The specifications of the node.

    polar.mysql.x4.large
    Category

    string

    The edition of the cluster. Valid values:

    • Normal: Cluster Edition.

    • Basic: Single Node Edition.

    • ArchiveNormal: X-Engine.

    • NormalMultimaster: Multi-master Cluster (Database/Table) Edition.

    • SENormal: Standard Edition.

    Note

    • Only PolarDB for MySQL supports Single Node Edition.

    • Only PolarDB for MySQL 8.0 supports X-Engine Edition and Multi-master Cluster (Database/Table) Edition.

    Normal
    ZoneId

    string

    The zone ID.

    cn-hangzhou-i
    RegionId

    string

    The region ID.

    cn-hangzhou

    Examples

    Success response

    JSON format

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

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidDBVersion.Malformed The Specified DBVersion is not valid. The specified DBVersion parameter is invalid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.