All Products
Search

This Product

    PolarDB:DescribeDBClusterVersion

    Document Center

    PolarDB:DescribeDBClusterVersion

    Last Updated:Oct 26, 2026

    Queries the details of the current kernel version of a PolarDB for MySQL cluster.

    Operation description

    Note

    For more information about the Milvus versions of PolarDB for MySQL clusters, see Milvus version overview and Kernel release notes.

    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:DescribeDBClusterVersion

    get

    *dbcluster

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    The cluster ID.

    Note

    You can call the DescribeDBClusters operation to query the details of all clusters under your account, such as the cluster ID.

    pc-****************
    DescribeType

    string

    No

    Specifies whether to return the latest version information or a list of upgradable versions. Valid values:

    • LATEST_VERSION: Queries the latest version information.

    • AVAILABLE_VERSION: Queries the list of upgradable versions.

    Valid values:

    • AVAILABLE_VERSION :

      The list of upgradable versions.

    • LATEST_VERSION :

      The latest version information.

    LATEST_VERSION

    Response elements

    Element

    Type

    Description

    Example

    object

    IsLatestVersion

    string

    Indicates whether the current database kernel engine version is the latest version. Valid values:

    • true

    • false

    true
    IsProxyLatestVersion

    string

    Indicates whether the current database proxy version is the latest version. Valid values:

    • true

    • false

    true
    DBVersion

    string

    The major version number of the database engine. Valid values:

    • 8.0

    • 5.7

    • 5.6

    8.0
    DBRevisionVersion

    string

    The Milvus version number of the database engine.

    Note

    For PolarDB for MySQL 5.6 clusters, only the Milvus version information with a release date after August 31, 2020 is returned. Otherwise, this parameter is empty. For more information about the kernel versions of PolarDB for MySQL clusters, see Kernel release notes.

    8.0.1.1.7
    RequestId

    string

    The request ID.

    47921222-0D37-4133-8C0D-017DC3******
    DBVersionStatus

    string

    The status of the current database minor version. Valid values:

    • Stable: The current version is stable.

    • Old: The current version is outdated. Upgrade to the latest version.

    • HighRisk: The current version has critical defects. Upgrade to the latest version immediately.

    • Beta: The current version is a beta release.

    Note

    For more information about how to upgrade the database minor version, see Version upgrade.

    Stable
    DBClusterId

    string

    The cluster ID.

    pc-****************
    DBMinorVersion

    string

    The minor version number of the database engine.

    • When DBVersion is 8.0, valid values:

      • 8.0.2

      • 8.0.1

    • When DBVersion is 5.7, the value is 5.7.28.

    • When DBVersion is 5.6, the value is 5.6.16.

    8.0.1
    ProxyRevisionVersion

    string

    The database proxy version.

    2.4.15
    ProxyVersionStatus

    string

    The version status of the database proxy. Valid values:

    • Stable: The current version is stable.

    • Old: The current version is outdated. Upgrade to the latest version.

    • HighRisk: The current version has critical defects. Upgrade to the latest version immediately.

    • Beta: The current version is a beta release.

    Note

    For more information about how to upgrade the database proxy version, see Version upgrade.

    Stable
    ProxyLatestVersion

    string

    The latest version of the database proxy.

    2.4.17
    DBLatestVersion

    string

    The latest version of the database kernel engine.

    8.0.1.1.16
    DBRevisionVersionList

    array<object>

    The list of upgradable versions.

    object

    ReleaseType

    string

    The release status of the database version. Valid values:

    • Stable: The current version is stable.

    • Old: The current version is outdated. Do not upgrade to this version.

    • HighRisk: The current version has critical defects. Do not upgrade to this version.

    • Beta: The current version is a beta release.

    Stable
    RevisionVersionCode

    string

    The revision version code of the database engine, which is used to specify the target version for the upgrade.

    20230707
    RevisionVersionName

    string

    The revision version number of the database engine.

    8.0.1.1.35.1
    ReleaseNote

    string

    The version release notes.

    ReleaseNote
    ProxyRevisionVersionList

    array<object>

    The release status of the database proxy version. Valid values:

    • Stable: The current version is stable.

    • Old: The current version is outdated. Do not upgrade to this version.

    • HighRisk: The current version has critical defects. Do not upgrade to this version.

    • Beta: The current version is a beta release.

    object

    ReleaseType

    string

    The release type. Valid values:

    • LTS: Long-term support version.

    • BETA: Preview version.

    LTS
    RevisionVersionCode

    string

    The revision version code of the database proxy engine, which is used to specify the target version for the upgrade.

    20230707
    RevisionVersionName

    string

    The revision version number of the database proxy engine.

    2.8.24
    ReleaseNote

    string

    The version release notes.

    ReleaseNote
    DBLatestStableVersion

    string

    The latest stable version of the PolarDB for PostgreSQL database.

    2.0.16.13.14.0
    IsLatestStableVersion

    string

    Indicates whether the version is the latest stable version of PolarDB for PostgreSQL.

    true

    Examples

    Success response

    JSON format

    {
  "IsLatestVersion": "true",
  "IsProxyLatestVersion": "true",
  "DBVersion": "8.0",
  "DBRevisionVersion": "8.0.1.1.7",
  "RequestId": "47921222-0D37-4133-8C0D-017DC3******",
  "DBVersionStatus": "Stable",
  "DBClusterId": "pc-****************",
  "DBMinorVersion": "8.0.1",
  "ProxyRevisionVersion": "2.4.15",
  "ProxyVersionStatus": "Stable",
  "ProxyLatestVersion": "2.4.17",
  "DBLatestVersion": "8.0.1.1.16",
  "DBRevisionVersionList": [
    {
      "ReleaseType": "Stable",
      "RevisionVersionCode": "20230707",
      "RevisionVersionName": "8.0.1.1.35.1",
      "ReleaseNote": "ReleaseNote"
    }
  ],
  "ProxyRevisionVersionList": [
    {
      "ReleaseType": "LTS",
      "RevisionVersionCode": "20230707",
      "RevisionVersionName": "2.8.24",
      "ReleaseNote": "ReleaseNote"
    }
  ],
  "DBLatestStableVersion": "2.0.16.13.14.0",
  "IsLatestStableVersion": "true"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.
    400 InvalidDBVersion.Malformed The Specified DBVersion is not valid. The specified DBVersion parameter is invalid.
    400 InvalidEngineVersion.Older The primary cluster version is too old, please upgrade it. The version of the primary cluster instance is out-of-date. Please upgrade the instance version.
    404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. The specified DBClusterId parameter does not exist in the current record.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.