Queries the kernel details of a PolarDB cluster of the ApsaraDB PolarDB MySQL-compatible edition.

Note For more information, see Version of the PolarDB database kernel and Release notes for the PolarDB kernel.

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

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

DBClusterId String Yes pc-****************

The ID of the PolarDB cluster.

Note You can call the DescribeDBClusters operation to query the details of each cluster that belongs to your account, such as the cluster ID.

Response parameters

Parameter Type Example Description
IsLatestVersion String true

Indicates whether the kernel version is the latest version. Valid values:

  • true
  • false
DBVersion String 8.0

The major version of the database engine. Valid values:

  • 8.0
  • 5.7
  • 5.6
DBRevisionVersion String 8.0.1.1.7

The patch version of the database engine.

Note For a cluster of the ApsaraDB PolarDB MySQL-compatible edition V5.6, the DBRevisionVersion parameter returns the patch version information only if the patch version is released later than August 31, 2020. Otherwise, this parameter returns an empty value. For more information about the kernel version of a cluster that runs the ApsaraDB PolarDB MySQL-compatible edition, see Release notes for the PolarDB kernel.
RequestId String 47921222-0D37-4133-8C0D-017DC3******

The ID of the request.

DBVersionStatus String Stable

The status of the minor version. Valid values:

  • Stable: The minor version is stable.
  • Old: The minor version is outdated. We recommend that you upgrade the cluster to the latest version.
  • HighRisk: The minor version has critical defects. We recommend that you immediately upgrade the cluster to the latest version.
Note For more information about how to upgrade the minor version, see Upgrade versions.
DBClusterId String pc-****************

The ID of the PolarDB cluster.

DBMinorVersion String 8.0.1

The minor version of the database engine.

  • If DBVersion is 8.0, the following values are valid:
    • 8.0.2
    • 8.0.1
  • If DBVersion is 5.7, the value of this parameter is 5.7.28.
  • If DBVersion is 5.6, the value of this parameter is 5.6.16.
ProxyRevisionVersion String 2.4.15

The version of the database proxy.

ProxyVersionStatus String Stable

The status of the proxy version. Valid values:

  • Stable: The proxy version is stable.
  • Old: The proxy version is outdated. We recommend that you upgrade the cluster to the latest version.
  • HighRisk: The proxy version has critical defects. We recommend that you immediately upgrade the cluster to the latest version.
Note For more information about how to upgrade the proxy version, see Upgrade versions.
ProxyLatestVersion String 2.4.17

The latest version of the database proxy.

DBLatestVersion String 8.0.1.1.16

The latest version of the database engine.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/?Action=DescribeDBClusterVersion
&DBClusterId=pc-****************
&<Common request parameters>

Sample success responses

XML format 

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

<DescribeDBClusterVersionResponse>
    <IsLatestVersion>true</IsLatestVersion>
    <DBVersion>8.0</DBVersion>
    <DBRevisionVersion>8.0.1.1.7</DBRevisionVersion>
    <RequestId>47921222-0D37-4133-8C0D-017DC3******</RequestId>
    <DBVersionStatus>Stable</DBVersionStatus>
    <DBClusterId>pc-****************</DBClusterId>
    <DBMinorVersion>8.0.1</DBMinorVersion>
    <ProxyRevisionVersion>2.4.15</ProxyRevisionVersion>
    <ProxyVersionStatus>Stable</ProxyVersionStatus>
    <ProxyLatestVersion>2.4.17</ProxyLatestVersion>
    <DBLatestVersion>8.0.1.1.16</DBLatestVersion>
</DescribeDBClusterVersionResponse>

JSON format 

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

{
  "IsLatestVersion" : "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"
}

Error codes

For a list of error codes, visit the API Error Center.