All Products
Search
Document Center

:DescribeEngineVersion

Last Updated:Nov 03, 2023

Queries the major version and minor version of an ApsaraDB for Redis instance and the release notes for minor versions.

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
kvstore:DescribeEngineVersionRead
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

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

r-bp1zxszhcgatnx****

Response parameters

ParameterTypeDescriptionExample
object
IsLatestVersionboolean

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

  • true
  • false
false
RequestIdstring

The request ID.

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

The minor version of proxy nodes.

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

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.

{\\"releaseInfo\\":{\\"createTime\\":\\"2021-07-27\\",\\"level\\":1,\\"releaseVersion\\":\\"0.5.4\\",\\"releaseNote\\":\\"\[Optimized feature]: The stability is improved. \\"}],\\"versionChangesLevel\\":2}
ProxyVersionReleasestring

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.
{\\"releaseInfo\\":\[{\\"createTime\\":\\"2021-06-08\\",\\"level\\":0,\\"releaseVersion\\":\\"6.6.2\\",\\"releaseNote\\":\\"\[New feature]: More commands are available for internal use within ApsaraDB for Redis. \\"}],\\"versionChangesLevel\\":2}
EnableUpgradeMajorVersionboolean

Indicates whether the instance major version 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
EnableUpgradeMinorVersionboolean

Indicates whether the instance minor version 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
MajorVersionstring

The major version of the instance.

5.0
Enginestring

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

redis
MinorVersionstring

The minor version of the instance.

redis-5.0_0.5.0
IsRedisCompatibleVersionstring

Indicates whether the instance runs a Redis version.

1
IsSSLEnablestring

Indicate whether the instance has the SSL encryption feature enabled.

1
IsNewSSLModestring

Indicates whether the instance supports the new SSL encryption feature.

1

Examples

Sample success responses

JSONformat

{
  "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\\\\\":\\\\\"\\[Optimized feature]: The stability is improved. \\\\\"}],\\\\\"versionChangesLevel\\\\\":2}\n",
  "ProxyVersionRelease": "{\\\\\"releaseInfo\\\\\":\\[{\\\\\"createTime\\\\\":\\\\\"2021-06-08\\\\\",\\\\\"level\\\\\":0,\\\\\"releaseVersion\\\\\":\\\\\"6.6.2\\\\\",\\\\\"releaseNote\\\\\":\\\\\"\\[New feature]: More commands are available for internal use within ApsaraDB for Redis. \\\\\"}],\\\\\"versionChangesLevel\\\\\":2}\n",
  "EnableUpgradeMajorVersion": true,
  "EnableUpgradeMinorVersion": true,
  "MajorVersion": "5.0",
  "Engine": "redis",
  "MinorVersion": "redis-5.0_0.5.0",
  "IsRedisCompatibleVersion": "1",
  "IsSSLEnable": "1",
  "IsNewSSLMode": "1"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-10-18The response structure of the API operation changes.see changesets
Change itemChange content
Output ParametersThe response structure of the API operation changes.
2022-11-15The response structure of the API operation changes.see changesets
Change itemChange content
Output ParametersThe response structure of the API operation changes.
2022-09-26The response structure of the API operation changes.see changesets
Change itemChange content
Output ParametersThe response structure of the API operation changes.