All Products
Search
Document Center

ApsaraDB RDS:DescribeDBMiniEngineVersions

Last Updated:Dec 05, 2024

Queries minor engine versions that are available for an ApsaraDB RDS for MySQL instance or an ApsaraDB RDS for PostgreSQL instance.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL

Usage notes

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

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.

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:DescribeDBMiniEngineVersionsget
*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:

  • 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: 15.0, 14.0, 13.0, 12.0, 11.0, and 10.0
5.7
NodeTypestringNo

The instance edition. 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 dedicated cluster ID. You can call the DescribeDedicatedHostGroups operation to query the dedicated cluster ID.

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 instance ID. You can call the DescribeDBInstances operation to query the instance ID.

rm-uf6wjk5*******
RegionIdstringYes

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

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

DBInstanceIdstring

The instance ID.

rm-uf6wjk5*****
RequestIdstring

The request ID.

EFB6083A-7699-489B-8278-C0CB4793A96E
TotalCountinteger

The total number of entries returned.

2
PageNumbersinteger

The page number returned.

1
MaxRecordsPerPageinteger

The number of entries returned per page.

10
MinorVersionItemsarray<object>

The details of the minor engine version.

MinorVersionItemsobject
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 do not need to specify 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. Valid values:

  • Offline: discontinued
  • Online: available
Note If the minor engine version is in the Offline state, the minor engine version is discontinued. In this case, ignore the expiration status. If the minor engine version is in the Online state and the expiration state is expired, the minor engine version expires. If the expiration state is vaild, the minor engine version is still in its lifecycle.
Online
EngineVersionstring

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

5.7
MinorVersionstring

The minor engine version.

rds_20220731
CommunityMinorVersionstring

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

Note This parameter is available only for instances that run 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 instances for which Babelfish is enabled
Note This parameter is available only for instances that run PostgreSQL.
pgsql_babelfish_image
ExpireStatusstring

The expiration status of the minor engine version. Valid values:

  • vaild
  • expired
Note If the minor engine version is in the Offline state, the minor engine version is discontinued. In this case, ignore the expiration status. If the minor engine version is in the Online state and the expiration state is expired, the minor engine version expires. If the expiration state is vaild, the minor engine version is still in its lifecycle.
vaild
ExpireDatestring

The expiration time of the minor engine version.

20231213

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",
      "ExpireStatus": "vaild",
      "ExpireDate": "20231213"
    }
  ]
}

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.-
400InvalidVersioncurrent version not support operation.-
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing plan price result not found.
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.Your account available limit is less than 0, please recharge before trying to purchase.
400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.The module you purchased is not legal, please buy it again.
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.Hello customer, this area has been abolished.
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.Hello customer, this area has been abolished.
400Price.CommoditySysCommodity system call exception.Commodity system call exception.
400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There is a problem with the period you selected, please choose again.
400pay.noCreditCardAccount not bound to credit card.-
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.-
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.Your basic information is not complete, please complete your basic information before operation.
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.Your account is abnormal, please contact customer service for details.
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.-
400System.SaleValidateFailedSales expression validation system error.A system error occurs when the sales expression is verified.
403IncorrectMinorVersionCurrent engine minor version does not support operations.This operation is not supported for the current minor engine version.
403OrderStatus.UnPaidThe specified db instance has unpaid order.The instance has an unpaid order. Please pay first and try again.
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
2024-11-20API Description Update. The Error code has changedView Change Details
2024-01-09The Error code has changedView Change Details
2023-12-07The Error code has changed. The response structure of the API has changedView Change Details
2023-09-08The Error code has changedView Change Details
2023-09-06The Error code has changed. The response structure of the API has changedView Change Details
2022-10-28The Error code has changedView Change Details
2022-06-13Add OperationView Change Details