DescribeDBClusterVersion - PolarDB - Alibaba Cloud Documentation Center

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
polardb:DescribeDBClusterVersion	Read	dbcluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the cluster.	pc-****************
DescribeType	string	No	Specify to return the latest version information or a list of upgradeable versions.Valid values: AVAILABLE_VERSION LATEST_VERSION	LATEST_VERSION

Response parameters

Parameter	Type	Description	Example
	object
IsLatestVersion	string	Indicates whether the kernel is of the latest version. Valid values: true false	true
IsProxyLatestVersion	string	Indicates whether PolarProxy uses the latest version. Valid values: true false	true
DBVersion	string	The version of the database engine. Valid values: 5.6 5.7 8.0	8.0
DBRevisionVersion	string	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
RequestId	string	The ID of the request.	47921222-0D37-4133-8C0D-017DC3******
DBVersionStatus	string	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
DBClusterId	string	The ID of cluster.	pc-****************
DBMinorVersion	string	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
ProxyRevisionVersion	string	The revision version of the database engine.	2.4.15
ProxyVersionStatus	string	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
ProxyLatestVersion	string	The latest version of PolarProxy.	2.4.17
DBLatestVersion	string	The latest version of the database engine.	8.0.1.1.16
DBRevisionVersionList	object []
ReleaseType	string	The release status of the revision version. Valid values: Stable: The revision version is stable. Old: The revision version is outdated. We recommend that you do not update the cluster to this version. HighRisk: The revision version has critical defects. We recommend that you do not update the cluster to this version.	Stable
RevisionVersionCode	string	The code of the revision version of the database engine to which the cluster can be upgraded.	20230707
RevisionVersionName	string	The revision version of the database engine.	8.0.1.1.35.1
ReleaseNote	string	The release notes for the 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"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.
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.

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

Change history

Change time

Summary of changes

Operation

2023-11-06

The Error code has changed. The request parameters of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: DescribeType

2023-09-12

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 400 change
	delete Error Codes: 404

2023-08-09

API Description Update. The Error code has changed

see changesets

Change item	Change content
API Description	API Description Update.
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404

2023-07-25

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
Output Parameters	The response structure of the API has changed.

2022-11-24

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	Added Error Codes: 404

2022-06-22

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.