All Products
Search

This Product

    Tair (Redis® OSS-Compatible):DescribeEngineVersion

    Document Center

    Tair (Redis® OSS-Compatible):DescribeEngineVersion

    Last Updated:Aug 28, 2026

    Queries the major and minor version information of a Tair (Redis OSS-compatible) instance, including the release notes for minor versions.

    Operation description

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    kvstore:DescribeEngineVersion

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

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

    r-bp1zxszhcgatnx****

    Response elements

    Element

    Type

    Description

    Example

    object

    IsLatestVersion

    boolean

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

    • true

    • false

    false
    RequestId

    string

    The request ID.

    A52974D1-9D57-4805-86CC-92E6EDE8****
    ProxyMinorVersion

    string

    The current minor version of the proxy node.

    Note

    This parameter is returned only for cluster and read/write splitting instances.

    6.6.0
    DBVersionRelease

    string

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

    {\"releaseInfo\":{\"createTime\":\"2021-07-27\",\"level\":1,\"releaseVersion\":\"0.5.4\",\"releaseNote\":\"功能更新：增强稳定性。\"}],\"versionChangesLevel\":2}
    ProxyVersionRelease

    string

    The release notes for the minor version of proxy nodes, including the release date, minor version number, release type, and description.

    Note

    This parameter is returned only for cluster and read/write splitting instances.

    {\"releaseInfo\":[{\"createTime\":\"2021-06-08\",\"level\":0,\"releaseVersion\":\"6.6.2\",\"releaseNote\":\"新特性：增加对部分内部命令的支持。\"}],\"versionChangesLevel\":2}
    EnableUpgradeMajorVersion

    boolean

    Indicates whether the major version of the instance can be upgraded. 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.

    true
    EnableUpgradeMinorVersion

    boolean

    Indicates whether the minor version of the instance can be updated. 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.

    true
    MajorVersion

    string

    The major version of the instance.

    5.0
    Engine

    string

    The database engine. Valid values: redis and memcache.

    redis
    MinorVersion

    string

    The current minor version of the instance.

    redis-5.0_0.5.0
    IsRedisCompatibleVersion

    string

    Indicates whether the instance runs a Redis-compatible version.

    1
    IsSSLEnable

    string

    Indicates whether SSL is enabled. Valid values:

    • 1: SSL is enabled.

    • 0: TLS is disabled.

    1
    IsNewSSLMode

    string

    Indicates whether Transport Layer Security (TLS) is enabled. Valid values:

    • 1: TLS is enabled.

    • 0: TLS is disabled.

    1
    IsAutoUpgradeOpen

    string

    Indicates whether automatic minor version updates are enabled. Valid values:

    • 0: Automatic minor version update is disabled.

    • 1: Automatic minor version update is enabled.

    0
    DBLatestMinorVersion

    object

    The latest minor version to which the instance can be updated.

    MinorVersion

    string

    The version number.

    7.0.1.4
    Level

    string

    The version update level. Valid values:

    • 0: regular

    • 1: recommended

    • 2: critical

    0
    VersionRelease

    object

    The update path from the current minor version to the latest minor version, consistent with the version documentation. For more information, see the release notes.

    VersionChangesLevel

    string

    The version update level, indicating how strongly the update is recommended. Valid values:

    • 0: regular

    • 1: recommended

    • 2: critical

    0
    ReleaseInfo

    object

    ReleaseInfoList

    array<object>

    The information about the minor versions.

    object

    The minor version information.

    ReleaseVersion

    string

    The release version of EMR.

    EMR-5.7.0
    CreateTime

    string

    The creation time of the instance.

    2022-11-21T13:28Z
    ReleaseNote

    string

    The release notes.

    发布说明
    Level

    string

    The importance level.

    0
    ReleaseNoteEn

    string

    The description of the minor versions to which the instance can be updated.

    版本升级英文描述
    ProxyLatestMinorVersion

    object

    The latest minor version to which the proxy node can be updated.

    MinorVersion

    string

    The version number.

    7.0.6
    Level

    string

    The version update level. Valid values:

    • 0: regular

    • 1: recommended

    • 2: critical

    0
    VersionRelease

    object

    The update path from the current minor version to the latest minor version, consistent with the version documentation. For more information, see the release notes.

    ReleaseInfo

    object

    ReleaseInfoList

    array<object>

    The information about the minor versions.

    object

    The minor version information.

    ReleaseVersion

    string

    The release version of EMR.

    EMR-5.9.1
    CreateTime

    string

    The time when the version was released.

    2022-08-23T14:26:20Z
    ReleaseNote

    string

    The release notes.

    x x x x
    Level

    string

    The version update level. Valid values:

    • 0: regular

    • 1: recommended

    • 2: critical

    0
    ReleaseNoteEn

    string

    The description of the minor versions to which the instance can be updated.

    版本升级英文描述
    VersionChangesLevel

    string

    The version update level, indicating how strongly the update is recommended. Valid values:

    • 0: regular

    • 1: recommended

    • 2: critical

    0
    IsOpenNGLB

    string

    Indicates whether the NGLB mode is enabled. Valid values:

    • 0: The NGLB mode is disabled.

    • 1: The NGLB mode is enabled.

    1

    Examples

    Success response

    JSON format

    {
  "IsLatestVersion": false,
  "RequestId": "A52974D1-9D57-4805-86CC-92E6EDE8****",
  "ProxyMinorVersion": "6.6.0",
  "DBVersionRelease": "{\\\"releaseInfo\\\":{\\\"createTime\\\":\\\"2021-07-27\\\",\\\"level\\\":1,\\\"releaseVersion\\\":\\\"0.5.4\\\",\\\"releaseNote\\\":\\\"功能更新：增强稳定性。\\\"}],\\\"versionChangesLevel\\\":2}",
  "ProxyVersionRelease": "{\\\"releaseInfo\\\":[{\\\"createTime\\\":\\\"2021-06-08\\\",\\\"level\\\":0,\\\"releaseVersion\\\":\\\"6.6.2\\\",\\\"releaseNote\\\":\\\"新特性：增加对部分内部命令的支持。\\\"}],\\\"versionChangesLevel\\\":2}",
  "EnableUpgradeMajorVersion": true,
  "EnableUpgradeMinorVersion": true,
  "MajorVersion": "5.0",
  "Engine": "redis",
  "MinorVersion": "redis-5.0_0.5.0",
  "IsRedisCompatibleVersion": "1",
  "IsSSLEnable": "1",
  "IsNewSSLMode": "1",
  "IsAutoUpgradeOpen": "0",
  "DBLatestMinorVersion": {
    "MinorVersion": "7.0.1.4",
    "Level": "0",
    "VersionRelease": {
      "VersionChangesLevel": "0",
      "ReleaseInfo": {
        "ReleaseInfoList": [
          {
            "ReleaseVersion": "EMR-5.7.0",
            "CreateTime": "2022-11-21T13:28Z",
            "ReleaseNote": "发布说明",
            "Level": "0",
            "ReleaseNoteEn": "版本升级英文描述"
          }
        ]
      }
    }
  },
  "ProxyLatestMinorVersion": {
    "MinorVersion": "7.0.6",
    "Level": "0",
    "VersionRelease": {
      "ReleaseInfo": {
        "ReleaseInfoList": [
          {
            "ReleaseVersion": "EMR-5.9.1",
            "CreateTime": "2022-08-23T14:26:20Z",
            "ReleaseNote": "x x x x",
            "Level": "0",
            "ReleaseNoteEn": "版本升级英文描述"
          }
        ]
      },
      "VersionChangesLevel": "0"
    }
  },
  "IsOpenNGLB": "1"
}

    Error response

    JSON format

    {
    "MinorVersion":"redis_0.12.4",
    "IsLatestVersion":"false",
    "MajorVersion":"2.8",
    "EnableUpgradeMajorVersion":"true",
    "RequestId":"A49A2216-F6C9-43E2-A8F0-F217E57943C4",
    "EnableUpgradeMinorVersion":"true",
    "Engine":"redis"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.