All Products
Search
Document Center

PolarDB:DescribeDBClusterVersion

Last Updated:Oct 09, 2024

Queries the information about the database engine version of a PolarDB for MySQL 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:DescribeDBClusterVersionget
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the cluster.

pc-****************
DescribeTypestringNo

Specifies whether to query the information about the latest versions or the versions to which the cluster can be updated. Valid values:

  • LATEST_VERSION: the information about the latest versions.
  • AVAILABLE_VERSION: the information about the versions to which the cluster can be updated.
LATEST_VERSION

Response parameters

ParameterTypeDescriptionExample
object
IsLatestVersionstring

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

  • true
  • false
true
IsProxyLatestVersionstring

Indicates whether PolarProxy uses the latest version. Valid values:

  • true
  • false
true
DBVersionstring

The version of the database engine. Valid values:

  • 5.6
  • 5.7
  • 8.0
8.0
DBRevisionVersionstring

The revision version of the database engine.

Note For a cluster of the PolarDB for MySQL 5.6, the DBRevisionVersion parameter returns the revision version information only if the Revision Version is released later than August 31, 2020. Otherwise, this parameter returns an empty value.
8.0.1.1.7
RequestIdstring

The ID of the request.

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

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 update the cluster to the latest minor version.
Note For more information about how to update the minor version, see Minor version update.
Stable
DBClusterIdstring

The ID of cluster.

pc-****************
DBMinorVersionstring

The minor version of the database engine.

  • If DBVersion is 8.0, the valid values of this parameter are:
    • 8.0.2
    • 8.0.1
  • If DBVersion is 5.7, set the value of this parameter to 5.7.28.
  • If DBVersion is 5.6, the value of this parameter is 5.6.16.
8.0.1
ProxyRevisionVersionstring

The revision version of the database engine.

2.4.15
ProxyVersionStatusstring

The status of PolarProxy. 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.
  • Beta: The minor version is a beta version.
Stable
ProxyLatestVersionstring

The latest version of PolarProxy.

2.4.17
DBLatestVersionstring

The latest version of the database engine.

8.0.1.1.16
DBRevisionVersionListarray<object>

The versions to which the cluster can be upgraded.

DBRevisionVersionListobject
ReleaseTypestring

The release status of the database engine revision version. Valid values:

  • Stable: The database engine revision version is stable.
  • Old: The database engine revision version is outdated. We recommend that you do not update the database engine to this revision version.
  • HighRisk: The database engine revision version has critical defects. We recommend that you do not update the database engine to this revision version.
  • Beta: The database engine revision version is a Beta version.
Stable
RevisionVersionCodestring

The code of the database engine revision version. You can use the code to specify the database engine revision version.

20230707
RevisionVersionNamestring

The database engine revision version number.

8.0.1.1.35.1
ReleaseNotestring

The release notes for the database engine revision version.

ReleaseNote
ProxyRevisionVersionListarray<object>

The release status of the PolarProxy version. Valid values:

  • Stable: The PolarProxy revision version is stable.
  • Old: The PolarProxy revision version is outdated. We recommend that you do not update the PolarProxy to this revision version.
  • HighRisk: The PolarProxy revision version has critical defects. We recommend that you do not update the PolarProxy to this revision version.
  • Beta: The PolarProxy revision version is a Beta version.
ProxyRevisionVersionListobject
ReleaseTypestring

The release type. Valid values:

  • LTS: a long-term version
  • BETA: a preview version
Stable
RevisionVersionCodestring

The PolarProxy revision version code. You can use this code to specify the PolarProxy revision version.

20230707
RevisionVersionNamestring

The PolarProxy revision version number.

2.8.24
ReleaseNotestring

The release notes for the PolarProxy revision version.

ReleaseNote

Examples

Sample success responses

JSONformat

{
  "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": "Stable",
      "RevisionVersionCode": "20230707",
      "RevisionVersionName": "2.8.24",
      "ReleaseNote": "ReleaseNote"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The specified DBClusterId parameter is invalid.
400InvalidDBVersion.MalformedThe Specified DBVersion is not valid.The specified DBVersion parameter is invalid.
400InvalidEngineVersion.OlderThe 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.
404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.

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

Change history

Change timeSummary of changesOperation
2024-05-28The Error code has changed. The response structure of the API has changedView Change Details
2023-11-06The Error code has changed. The request parameters of the API has changedView Change Details
2023-09-12The Error code has changedView Change Details
2023-08-09API Description Update. The Error code has changedView Change Details
2023-07-25The Error code has changed. The response structure of the API has changedView Change Details
2022-11-24The Error code has changedView Change Details
2022-06-22The response structure of the API has changedView Change Details