DescribeAvailableClasses - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the specifications that are supported for an instance. The specifications include the instance type and the storage capacity.

Operation description

Supported database engines

MySQL
PostgreSQL
SQL Server
MariaDB

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the region ID of the instance.	cn-hangzhou
ZoneId	string	Yes	The zone ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the zone ID of the instance. Note If the DescribeDBInstanceAttribute operation returns multiple zones, you must specify only one of the returned zones. For example, if the DescribeDBInstanceAttribute operation returns `cn-hangzhou-MAZ9(g,h)`, you can set this parameter to `cn-hangzhou-g` or `cn-hangzhou-h`.	cn-hangzhou-h
InstanceChargeType	string	Yes	The billing method of the instance. Valid values: Prepaid: subscription Postpaid: pay-as-you-go Serverless: serverless Note ApsaraDB RDS for MariaDB does not support serverless instances.	Prepaid
Engine	string	Yes	The database engine that is run by the instance. Valid values: MySQL SQLServer PostgreSQL MariaDB	MySQL
EngineVersion	string	Yes	The database engine version of the instance. Valid values: Regular instance Valid values if you set Engine to MySQL: 5.5, 5.6, 5.7, and 8.0 Valid values if you set Engine to SQLServer: 2008r2, 08r2_ent_ha, 2012, 2012_ent_ha, 2012_std_ha, 2012_web, 2014_std_ha, 2016_ent_ha, 2016_std_ha, 2016_web, 2017_std_ha, 2017_ent, 2019_std_ha, and 2019_ent Valid values if you set Engine to PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, and 15.0 Valid value when you set Engine to MariaDB: 10.3 Serverless instance Valid values if you set Engine to MySQL: 5.7 and 8.0 Valid values if you set Engine to SQLServer: 2016_std_sl, 2017_std_sl, and 2019_std_sl Valid value if you set Engine to PostgreSQL: 14.0 Note ApsaraDB RDS for MariaDB does not support serverless instances.	8.0
DBInstanceId	string	No	The instance ID. You can call the DescribeDBInstances operation to query the instance ID.	rm-uf6wjk5xxxxxx
OrderType	string	No	The type of the order. Set the value to BUY	BUY
DBInstanceStorageType	string	Yes	The storage type of the instance. Valid values: local_ssd: local SSD. This is the recommended storage type. cloud_ssd: standard SSD. cloud_essd: enhanced SSDs (ESSDs) of performance level 1 (PL1) cloud_essd2: ESSDs of PL2 cloud_essd3: ESSD of PL3 Note Serverless instances support only ESSDs of PL 1. For a serverless instance, you must set this parameter to cloud_essd.	local_ssd
Category	string	Yes	The RDS edition of the instance. Valid values: Regular instance Basic: RDS Basic Edition HighAvailability: RDS High-availability Edition cluster: RDS Cluster Edition for ApsaraDB RDS for MySQL AlwaysOn: RDS Cluster Edition for ApsaraDB RDS for SQL Server Finance: RDS Enterprise Edition Serverless instance serverless_basic: RDS Basic Edition. This edition is available only for serverless instances that run MySQL and PostgreSQL. serverless_standard: RDS High-availability Edition for ApsaraDB RDS for MySQL. serverless_ha: RDS High-availability Edition for ApsaraDB RDS for SQL Server. Note If you create a serverless instance, you must specify this parameter.	HighAvailability
CommodityCode	string	No	The commodity code of the instance. Valid values: bards: The instance is a pay-as-you-go primary instance. This value is available at the China site (aliyun.com). rds: The instance is a subscription primary instance. This value is available at the China site (aliyun.com). rords: The instance is a pay-as-you-go read-only instance. This value is available at the China site (aliyun.com). rds_rordspre_public_cn: The instance is a subscription read-only instance. This value is available at the China site (aliyun.com). bards_intl: The instance is a pay-as-you-go primary instance. This value is available at the International site (alibabacloud.com). rds_intl: The instance is a subscription primary instance. This value is available at the International site (alibabacloud.com). rords_intl: The instance is a pay-as-you-go read-only instance. This value is available at the International site (alibabacloud.com). rds_rordspre_public_intl: The instance is a subscription read-only instance. This value is available at the International site (alibabacloud.com). rds_serverless_public_cn: The instance is a serverless instance. This value is available at the China site (aliyun.com). rds_serverless_public_intl: The instance is a serverless instance. This value is available at the International site (alibabacloud.com). Note If you want to query the price of a read-only instance, you must specify this parameter.	bards

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC
DBInstanceClasses	array<object>	An array that consists of the instance types available for the instance.
	object
DBInstanceClass	string	The instance type of the instance.	rds.mysql.c1.large
DBInstanceStorageRange	object	The storage capacity range that is supported for the instance.
Step	integer	The minimum step size at which you can adjust the storage capacity of the instance. The minimum step size is 5 GB.	5
MinValue	integer	The minimum storage capacity that is supported for the instance. Unit: GB.	5
MaxValue	integer	The maximum storage capacity that is supported for the instance. Unit: GB.	2000

Examples

Sample success responses

JSONformat

{
  "RequestId": "7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC",
  "DBInstanceClasses": [
    {
      "DBInstanceClass": "rds.mysql.c1.large",
      "DBInstanceStorageRange": {
        "Step": 5,
        "MinValue": 5,
        "MaxValue": 2000
      }
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-03-14	The Error code has changed	View Change Details

HTTP status code	Error code	Error message	Description
400	ArticleNotFound	Article not found	No relevant constraints are found.
400	InvalidDBInstanceName	The specified parameter DBInstanceName is null or the instance cannot be found, please check parameter DBInstanceName.	The specified parameter DBInstanceName is null or the instance cannot be found, please check parameter DBInstanceName.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You 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 user center for real-name authentication.
400	InsufficientAvailableQuota	Your 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.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Failed to call commodity service return.
400	RegionDissolvedEOM	Dear 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.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedIndia	Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.	Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.	-
400	Order.InstHasUnpaidOrder	There 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.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	-
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is not complete, please complete your basic information before operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Your account is abnormal, please contact customer service for details.
400	BasicInfoUncompleted	Your information is incomplete, Complete your information before the operation.	-
400	System.SaleValidateFailed	Sales expression validation system error.	A system error occurs when the sales expression is verified.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.
404	InvalidDBInstanceName.NotFound	DBInstanceName not found	-
404	InvalidCondition.NotFound	No class found	The operation failed. The condition of the available class is invalid.