All Products
Search
Document Center

ApsaraDB RDS:DescribeDBMiniEngineVersions

Last Updated:May 29, 2023

You can call the DescribeDBMiniEngineVersions operation to query minor engine versions that are available for ApsaraDB RDS for MySQL instances and ApsaraDB RDS for PostgreSQL instances.

Operation Description

Before you purchase or upgrade an ApsaraDB RDS for MySQL instance or an ApsaraDB RDS for PostgreSQL instance, you can call the DescribeDBMiniEngineVersions operation to query the minor engine versions that are available for the instance.

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
rds:DescribeDBMiniEngineVersionsRead
    All Resources
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
EnginestringNo

The database engine of the instance. Valid values: MySQL and PostgreSQL.

MySQL
EngineVersionstringNo

The database engine version of the instance.

  • Valid values when you set the Engine parameter to MySQL: 8.0, 5.7, 5.6, and 5.5
  • Valid values when you set the Engine parameter to PostgreSQL: 14.0, 13.0, 12.0, 11.0, and 10.0
5.7
NodeTypestringNo

The RDS edition of the instance. Valid values:

  • Basic: RDS Basic Edition
  • HighAvailability: RDS High-availability Edition
  • Finance: RDS Enterprise Edition
HighAvailability
StorageTypestringNo

The storage type of the instance. Valid values:

  • local_ssd: local SSD
  • cloud_ssd: standard SSD
  • cloud_essd: enhanced SSD (ESSD) of performance level 1 (PL1)
  • cloud_essd2: ESSD of PL2
  • cloud_essd3: ESSD of PL3
local_ssd
DedicatedHostGroupIdstringNo

The ID of the dedicated cluster. You can call the DescribeDedicatedHostGroups operation to query the ID of the dedicated cluster.

dhg-4n*****
MinorVersionTagstringNo

The minor engine version of the instance. You can specify this parameter to query the minor engine version of the instance.

rds_20220731
DBInstanceIdstringNo

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

rm-uf6wjk5*******
RegionIdstringYes

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
DBInstanceIdstring

The ID of the instance.

rm-uf6wjk5*****
RequestIdstring

The ID of the request.

EFB6083A-7699-489B-8278-C0CB4793A96E
TotalCountinteger

The total number of returned entries.

2
PageNumbersinteger

The page number of the returned page.

1
MaxRecordsPerPageinteger

The number of entries returned per page.

10
MinorVersionItemsobject []

An array that consists of details of the minor engine versions.

ReleaseNotestring

The URL of the release notes for the minor engine version.

https://example.com
NodeTypestring

The RDS edition of the instance that runs the minor engine version. Valid values:

  • Basic: RDS Basic Edition
  • HighAvailability: RDS High-availability Edition
  • Finance: RDS Enterprise Edition
HighAvailability
IsHotfixVersionboolean

An internal parameter. You can ignore this parameter.

True
Enginestring

The database engine that corresponds to the minor engine version.

MySQL
ReleaseTypestring

The release type. Valid values:

  • LTS: a long-term version
  • BETA: a preview version
BETA
StatusDescstring

The status of the minor engine version.

Online
EngineVersionstring

The database engine version that corresponds to the minor engine version.

5.7
MinorVersionstring

The version of the minor engine.

rds_20220731
CommunityMinorVersionstring

The PostgreSQL version to which the minor engine version corresponds. For more information, see Release notes for AliPG.

NoteThis parameter is valid only when the Engine parameter is set to PostgreSQL.
13.6
Tagstring

The tag that corresponds to the minor engine version. Valid values:

  • pgsql_docker_image: tag of common instances
  • pgsql_babelfish_image: tag of the instance for which Babelfish is enabled
NoteThis parameter is valid only when the Engine parameter is set to PostgreSQL.
pgsql_babelfish_image

Examples

Sample success responses

JSONformat

{
  "DBInstanceId": "rm-uf6wjk5*****",
  "RequestId": "EFB6083A-7699-489B-8278-C0CB4793A96E",
  "TotalCount": 2,
  "PageNumbers": 1,
  "MaxRecordsPerPage": 10,
  "MinorVersionItems": [
    {
      "ReleaseNote": "https://example.com",
      "NodeType": "HighAvailability",
      "IsHotfixVersion": true,
      "Engine": "MySQL",
      "ReleaseType": "BETA",
      "StatusDesc": "Online",
      "EngineVersion": "5.7",
      "MinorVersion": "rds_20220731",
      "CommunityMinorVersion": "13.6",
      "Tag": "pgsql_babelfish_image"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400MinorVersionAttr.NotFoundCannot find minor version attribute by given custins.-
400InvalidDBInstanceName.NotFoundThe specified DB instance name does not exist.The instance name does not exist.
400EngineNotSupportedEngine specified cannot be supported the operation.The operation failed. This operation is not supported for the database engine version of the RDS instance. Update the minor engine version of the RDS instance.
400MissingMinorVersionTagYou must specify MinorVersionTag.-
400MissingParameter.EngineYou must specify Engine.-
400MissingParameter.EngineVersionYou must specify EngineVersion.-
400InvalidInstanceNodeType.NotFoundThe specified NodeType is not found.-
400MinorVersionTag.NotFoundMinor version tags cannot be parsed by the instance.-
404InvalidInstanceStorageType.NotFoundThe specified DBInstanceStorageType is not found.You must specify the InstanceStorageType parameter.
404InvalidDBInstance.NotFoundThe specified instance does not exist or is not supported.The RDS instance cannot be found. Check the ID or name of the RDS instance.

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

Change history

Change timeSummary of changesOperation
2022-10-28The error codes of the API operation change.
Change itemChange content
Error CodesThe error codes of the API operation change.
    Error Codes 400 change
    Added Error Codes: 404
2022-06-13Add Operation