Queries the specifications that are supported for an instance. The specifications include the instance type and the storage capacity.
Operation description
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
rds:DescribeAvailableClasses | READ |
|
| none |
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:
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 |
EngineVersion | string | Yes | The database engine version of the instance. Valid values:
| 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:
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:
| HighAvailability |
CommodityCode | string | No | The commodity code of the instance. Valid values:
Note
If you want to query the price of a read-only instance, you must specify this parameter.
| bards |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC",
"DBInstanceClasses": [
{
"DBInstanceClass": "rds.mysql.c1.large",
"DBInstanceStorageRange": {
"Step": 5,
"MinValue": 5,
"MaxValue": 2000
}
}
]
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | ArticleNotFound | Article not found | No relevant constraints are found. |
404 | InvalidDBInstanceName.NotFound | DBInstanceName not found | - |
404 | InvalidCondition.NotFound | No class found | The operation failed. The condition of the available class is invalid. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|