DescribeClassDetails - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the details about the instance types of an instance by using the code of the instance types.

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
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOCz*****
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
CommodityCode	string	Yes	The commodity code of the instance. Valid values: bards_intl: The instance is a pay-as-you-go primary instance. rds_intl: The instance is a subscription primary instance. rords_intl: The instance is a pay-as-you-go read-only instance. rds_rordspre_public_intl: The instance is a subscription read-only instance.	rds
ClassCode	string	Yes	The code of the instance type.	rds.mysql.s3.large
EngineVersion	string	Yes	The database engine version of the instance.	5.6
Engine	string	Yes	The type of the database engine.	MySQL
ResourceGroupId	string	No	The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.	rg-acfmy*****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34
ClassCode	string	The code of the instance type.	mysql.n2.medium.1
MaxIOMBPS	string	The maximum I/O bandwidth that is supported by the instance type. Unit: Mbit/s.	1024
MaxConnections	string	The maximum number of connections.	4000
ClassGroup	string	The instance family of the instance.	x
Cpu	string	The number of CPU cores that are supported by the instance type. Unit: cores.	4
InstructionSetArch	string	The architecture of the instance.	x86
MemoryClass	string	The memory size. Unit: GB.	2GB
MaxIOPS	string	The maximum input/output operations per second (IOPS) that is supported by the instance type. Unit: operations per second.	N/A
ReferencePrice	string	The price. Unit: cents (US dollars). Note If you set the CommodityCode parameter to a value that indicates the pay-as-you-go billing method, the ReferencePrice parameter specifies the hourly fee that you must pay. If you set the CommodityCode parameter to a value that indicates the subscription billing method, the ReferencePrice parameter specifies the monthly fee that you must pay.	13400
Category	string	The RDS edition of the instance. Valid values: Basic: RDS Basic Edition HighAvailability: RDS High-availability Edition AlwaysOn: RDS Cluster Edition Finance: RDS Enterprise Edition	Basic
DBInstanceStorageType	string	The storage type of the instance. Valid values: local_ssd: local SSDs cloud_ssd: standard SSDs cloud_essd: enhanced SSDs (ESSDs) of performance level 1 (PL1) cloud_essd2: ESSDs of PL2 cloud_essd3: ESSD of PL3	local_ssd

Examples

Sample success responses

JSONformat

{
  "RequestId": "E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34",
  "ClassCode": "mysql.n2.medium.1",
  "MaxIOMBPS": "1024",
  "MaxConnections": "4000",
  "ClassGroup": "x",
  "Cpu": "4",
  "InstructionSetArch": "x86",
  "MemoryClass": "2GB",
  "MaxIOPS": "N/A",
  "ReferencePrice": "13400",
  "Category": "Basic",
  "DBInstanceStorageType": "local_ssd"
}

Error codes

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

Change history

Change time

Summary of changes

Operation

2023-07-25

The Error code has changed. The request parameters of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: ResourceGroupId

HTTP status code	Error code	Error message	Description
400	InvalidClassCode.NotFound	Invalid ClassCode NotFound.	The operation failed because the code of the instance type does not exist.
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.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.