Queries the major version and minor version of an instance, the minor version of proxy nodes, and the release notes for the minor versions.

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 Yes DescribeEngineVersion

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

InstanceId String Yes r-bp1zxszhcgatnx****

The ID of the instance. You can call the DescribeInstances operation to query instance IDs.

Response parameters

Parameter Type Example Description
IsLatestVersion Boolean false

Indicates whether the instance minor version is the latest version. Valid values:

  • true: The instance minor version is the latest version.
  • false: The instance minor version is not the latest version.
RequestId String A52974D1-9D57-4805-86CC-92E6EDE8****

The ID of the request.

ProxyMinorVersion String 6.6.0

The minor version of proxy nodes.

Note This parameter is returned only for cluster and read/write splitting instances.
DBVersionRelease String {\"releaseInfo\":[{\"createTime\":\"2021-04-26\",\"level\":2,\"releaseVersion\":\"0.5.2\",\"releaseNote\":\"[Security hardening]: The security vulnerabilities of open source LuaJIT are fixed. \\n[New feature]: The migration mechanism for slots is optimized to allow instances that use cloud disks to be scaled without data loss. \\n[New feature]: The statistics about large keys can be collected in real time. \\n[New feature]: Virtual IP addresses (VIPs) can be obtained over the Internet. This provides better support for users who use private endpoints. \\n\"},{\"createTime\":\"2021-07-21\",\"level\":1,\"releaseVersion\":\"0.5.3\",\"releaseNote\":\"[Optimized feature]: The process of deleting source data after data migration is complete is optimized to improve data reliability. \\n[Optimized feature]: The process of incremental data migration is simplified. \"},{\"createTime\":\"2021-07-27\",\"level\":1,\"releaseVersion\":\"0.5.4\",\"releaseNote\":\"[Optimized feature]: The stability is improved. \"}],\"versionChangesLevel\":2}

The release notes for the minor version of the instance, including the release date, minor version number, release type such as new feature, and description.

ProxyVersionRelease String {\"releaseInfo\":[{\"createTime\":\"2021-05-26\",\"level\":0,\"releaseVersion\":\"6.6.1\",\"releaseNote\":\"[New feature]: The TairZset data module is supported. You can sort elements in a TairZset key based on score data of the DOUBLE type by using different dimensions. The TairZset data module improves the efficiency of data processing and is easy to use on clients because you do not need to encode, decode, or encapsulate data. For more information, see TairZset commands. \"},{\"createTime\":\"2021-06-08\",\"level\":0,\"releaseVersion\":\"6.6.2\",\"releaseNote\":\"[New feature]: More commands of ApsaraDB for Redis are supported for internal use. \"},{\"createTime\":\"2021-06-18\",\"level\":1,\"releaseVersion\":\"6.6.3\",\"releaseNote\":\"[Optimized feature]: Background instance management is optimized in multi-zone disaster recovery scenarios. \"},{\"createTime\":\"2021-07-08\",\"level\":2,\"releaseVersion\":\"6.6.4\",\"releaseNote\":\"[New feature]: The CLIENT LIST or CLIENT KILL command can be used to query or manage client connections by process. \\n[Fixed issue]: The issue that TairZset commands do not support uppercase letters is fixed. \"}],\"versionChangesLevel\":2}

The release notes for the minor version of proxy nodes. The release notes include the release date, minor version number, release type such as new feature, and description.

Note This parameter is returned only for cluster and read/write splitting instances.
EnableUpgradeMajorVersion Boolean true

Indicates whether the major version can be upgraded for the instance. Valid values:

  • true: The major version can be upgraded.
  • false: The major version is the latest version and cannot be upgraded.
Note To upgrade the major version, call the ModifyInstanceMajorVersion operation.
EnableUpgradeMinorVersion Boolean true

Indicates whether the minor version can be updated for the instance. Valid values:

  • true: The minor version can be updated.
  • false: The minor version is the latest version and cannot be updated.
Note To update the minor version, call the ModifyInstanceMinorVersion operation.
MajorVersion String 5.0

The major version of the instance.

Engine String redis

The database engine of the instance. Valid values: redis and memcache.

MinorVersion String redis-5.0_0.5.0

The minor version of the instance.

IsRedisCompatibleVersion Boolean 1

Indicates whether the instance supports the new SSL encryption feature.

Examples

Sample requests

https://r-kvstore.aliyuncs.com/?Action=DescribeEngineVersion
&InstanceId=r-bp1zxszhcgatnx****
&<Common request parameters>

Sample success responses

XML format 

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

<DescribeEngineVersionResponse>
    <MajorVersion>5.0</MajorVersion>
    <IsLatestVersion>false</IsLatestVersion>
    <RequestId>825F9CF7-4AE5-520C-93C7-7E0D2BEA0F8F</RequestId>
    <MinorVersion>redis-5.0_0.5.0</MinorVersion>
    <ProxyMinorVersion>6.6.0</ProxyMinorVersion>
    <Engine>redis</Engine>
    <EnableUpgradeMinorVersion>true</EnableUpgradeMinorVersion>
    <ProxyVersionRelease>{"releaseInfo":[{"createTime":"2021-05-26","level":0,"releaseVersion":"6.6.1","releaseNote":"[New feature]: The TairZset data module is supported. You can sort elements in a TairZset key based on score data of the DOUBLE type by using different dimensions. The TairZset data module improves the efficiency of data processing and is easy to use on clients because you do not need to encode, decode, or encapsulate data. For more information, see TairZset commands."},{"createTime":"2021-06-08","level":0,"releaseVersion":"6.6.2","releaseNote":"[New feature]: More commands of ApsaraDB for Redis are supported for internal use."},{"createTime":"2021-06-18","level":1,"releaseVersion":"6.6.3","releaseNote":"[Optimized feature]: Background instance management is optimized in multi-zone disaster recovery scenarios."},{"createTime":"2021-07-08","level":2,"releaseVersion":"6.6.4","releaseNote":"[New feature]: The CLIENT LIST or CLIENT KILL command can be used to query or manage client connections by process. \n[Fixed issue]: The issue that TairZset commands do not support uppercase letters is fixed."}],"versionChangesLevel":2}</ProxyVersionRelease>
    <EnableUpgradeMajorVersion>false</EnableUpgradeMajorVersion>
    <DBVersionRelease>{"releaseInfo":[{"createTime":"2021-04-26","level":2,"releaseVersion":"0.5.2","releaseNote":"[Security hardening]: The security vulnerabilities of open source LuaJIT are fixed. \n[New feature]: The migration mechanism for slots is optimized to allow instances that use cloud disks to be scaled without data loss. \n[New feature]: The statistics about large keys can be collected in real time. \n[New feature]: VIPs can be obtained over the Internet. This provides better support for users who use private endpoints. \n"},{"createTime":"2021-07-21","level":1,"releaseVersion":"0.5.3","releaseNote":"[Optimized feature]: The process of deleting source data after data migration is complete is optimized to improve data reliability. \n[Optimized feature]: The process of incremental data migration is simplified."},{"createTime":"2021-07-27","level":1,"releaseVersion":"0.5.4","releaseNote":"[Optimized feature]: The stability is improved."}],"versionChangesLevel":2}</DBVersionRelease>
</DescribeEngineVersionResponse>

JSON format 

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

{
  "MajorVersion" : "5.0",
  "IsLatestVersion" : false,
  "RequestId" : "825F9CF7-4AE5-520C-93C7-7E0D2BEA0F8F",
  "MinorVersion" : "redis-5.0_0.5.0",
  "ProxyMinorVersion" : "6.6.0",
  "Engine" : "redis",
  "EnableUpgradeMinorVersion" : true,
  "ProxyVersionRelease" : "{\"releaseInfo\":[{\"createTime\":\"2021-05-26\",\"level\":0,\"releaseVersion\":\"6.6.1\",\"releaseNote\":\"[New feature]: The TairZset data module is supported. You can sort elements in a TairZset key based on score data of the DOUBLE type by using different dimensions. The TairZset data module improves the efficiency of data processing and is easy to use on clients because you do not need to encode, decode, or encapsulate data. For more information, see TairZset commands. \"},{\"createTime\":\"2021-06-08\",\"level\":0,\"releaseVersion\":\"6.6.2\",\"releaseNote\":\"[New feature]: More commands of ApsaraDB for Redis are supported for internal use. \"},{\"createTime\":\"2021-06-18\",\"level\":1,\"releaseVersion\":\"6.6.3\",\"releaseNote\":\"[Optimized feature]: Background instance management is optimized in multi-zone disaster recovery scenarios. \"},{\"createTime\":\"2021-07-08\",\"level\":2,\"releaseVersion\":\"6.6.4\",\"releaseNote\":\"[New feature]: The CLIENT LIST or CLIENT KILL command can be used to query or manage client connections by process. \\n[Fixed issue]: The issue that TairZset commands do not support uppercase letters is fixed. \"}],\"versionChangesLevel\":2}",
  "EnableUpgradeMajorVersion" : false,
  "DBVersionRelease" : "{\"releaseInfo\":[{\"createTime\":\"2021-04-26\",\"level\":2,\"releaseVersion\":\"0.5.2\",\"releaseNote\":\"[Security hardening]: The security vulnerabilities of open source LuaJIT are fixed. \\n[New feature]: The migration mechanism for slots is optimized to allow instances that use cloud disks to be scaled without data loss. \\n[New feature]: The statistics about large keys can be collected in real time. \\n[New feature]: VIPs can be obtained over the Internet. This provides better support for users who use private endpoints. \\n\"},{\"createTime\":\"2021-07-21\",\"level\":1,\"releaseVersion\":\"0.5.3\",\"releaseNote\":\"[Optimized feature]: The process of deleting source data after data migration is complete is optimized to improve data reliability. \\n[Optimized feature]: The process of incremental data migration is simplified. \"},{\"createTime\":\"2021-07-27\",\"level\":1,\"releaseVersion\":\"0.5.4\",\"releaseNote\":\"[Optimized feature]: The stability is improved. \"}],\"versionChangesLevel\":2}"
}

Error codes

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