All Products
Search

This Product

    PolarDB:DescribeDBClusterVersion

    Document Center

    PolarDB:DescribeDBClusterVersion

    Last Updated:Nov 07, 2023

    Queries the information about the database engine version of a PolarDB for MySQL cluster.

    Operation Description

    Note For more information, see Engine versions and PolarDB for MySQL.

    debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    debugging

    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:DescribeDBClusterVersionREAD
    • dbcluster
      acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBClusterIdstringYes

    The ID of the cluster.

    Note You can call the DescribeDBClusters operation to query the details of all the clusters for your account, such as the cluster ID.
    		pc-****************

    Response parameters

    ParameterTypeDescriptionExample
    object
    IsLatestVersionstring

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

    • true
    • false
    		true
    IsProxyLatestVersionstring

    Indicates whether PolarProxy is the latest version. Valid values:

    • true
    • false
    		true
    DBVersionstring

    The major version of the database engine. Valid values:

    • 8.0
    • 5.7
    • 5.6
    		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. For more information about the kernel version of a cluster that runs the PolarDB for MySQL, see PolarDB for MySQL.
    		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 upgrade the cluster to the latest version.
    Note For more information about how to upgrade the minor version, see Upgrade versions.
    		Stable
    DBClusterIdstring

    The ID of the 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 version of PolarProxy.

    		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.
    Note For more information about how to upgrade the PolarProxy version, see Upgrade versions.
    		Stable
    ProxyLatestVersionstring

    The latest version of PolarProxy.

    		2.4.17
    DBLatestVersionstring

    The latest version of the database engine.

    		8.0.1.1.16

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

    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
    2023-11-06The error codes of the API operation change.,The input parameters of the API operation change.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 404
    Input ParametersThe input parameters of the API operation change.
      Added Input Parameters: DescribeType
    2023-09-12The error codes of the API operation change.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
      delete Error Codes: 404
    2023-08-09API Description Update,The error codes of the API operation change.see changesets
    Change itemChange content
    API DescriptionAPI Description Update
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 404
    2023-07-25The error codes of the API operation change.,The response structure of the API operation changes.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 404
    Output ParametersThe response structure of the API operation changes.
    2022-11-24The error codes of the API operation change.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      Added Error Codes: 404
    2022-06-22The response structure of the API operation changes.see changesets
    Change itemChange content
    Output ParametersThe response structure of the API operation changes.