All Products
Search
Document Center

ApsaraDB RDS:ListClasses

Last Updated:Mar 13, 2024

Queries the specification details of an instance.

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

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 token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

ETnLKlblzczshOTUbOCzxxxxxxx
CommodityCodestringYes

The commodity code of the instances.

  • bards_intl: The instances are pay-as-you-go primary instances.
  • rds_intl: The instances are subscription primary instances.
  • rords_intl: The instances are pay-as-you-go read-only instances.
  • rds_rordspre_public_intl: The instances are subscription read-only instances.
bards_intl
DBInstanceIdstringNo

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

Note If you set the CommodityCode parameter to the commodity code of read-only instances, you must specify this parameter.
rm-uf6wjk5xxxxxxx
OrderTypestringYes

The type of order that you want to query. Valid values:

  • BUY: specifies the query orders that are used to purchase instances.
  • UPGRADE: specifies the query orders that are used to change the specifications of instances.
  • RENEW: specifies the query orders that are used to renew instances.
  • CONVERT: specifies the query orders that are used to change the billing methods of instances.
BUY
RegionIdstringNo

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

Note If you are using an Alibaba Cloud account on the International site (alibabacloud.com), you must specify this parameter.
cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

CF8D35BF-263D-4F7B-883A-1163B79A9EC6
RegionIdstring

The ID of the region.

cn-hangzhou
Itemsobject []

The list of instance specifications.

MaxIOPSstring

The maximum input/output operations per second (IOPS) that is supported by the instance type. Unit: operations per second.

10000
Cpustring

The number of CPU cores that are supported by the instance type. Unit: cores.

1
ReferencePricestring

The fee that you must pay for the instance type.

  • Unit: cents (USD).
Note
  • If you set CommodityCode 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 CommodityCode to a value that indicates the subscription billing method, the ReferencePrice parameter specifies the monthly fee that you must pay.

2500
MaxConnectionsstring

The maximum number of connections that are supported by the instance type. Unit: connections.

2000
MemoryClassstring

The memory size that is supported by the instance type. Unit: GB.

1 GB (RDS Basic Edition)
ClassCodestring

The code of the instance type. For more information, see Primary ApsaraDB RDS instance types and Read-only ApsaraDB RDS instance types.

mysql.n1.micro.1
ClassGroupstring

The instance family. For more information, see Overview of instance families.

General
MaxIOMBPSstring

The maximum I/O bandwidth that is supported by the instance type. Unit: Mbit/s.

1024Mbps
EncryptedMemorystring

The size of the encrypted memory that is supported by the security-enhanced instance type. Unit: GB.

4
InstructionSetArchstring

The architecture of the instance type. Valid values:

  • If the architecture of the instance type is x86, an empty string is returned by default.
  • If the architecture of the instance type is ARM, arm is returned.
arm

Examples

Sample success responses

JSONformat

{
  "RequestId": "CF8D35BF-263D-4F7B-883A-1163B79A9EC6",
  "RegionId": "cn-hangzhou",
  "Items": [
    {
      "MaxIOPS": "10000",
      "Cpu": "1",
      "ReferencePrice": "2500",
      "MaxConnections": "2000",
      "MemoryClass": "1 GB (RDS Basic Edition)\n",
      "ClassCode": "mysql.n1.micro.1",
      "ClassGroup": "General\n",
      "MaxIOMBPS": "1024Mbps",
      "EncryptedMemory": "4",
      "InstructionSetArch": "arm"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidSecurityIPList.MalformedThe specified parameter SecurityIPList is not valid.-
400InvalidSecurityIPList.DuplicateThe Security IP address is not in the available range or occupied.The IP address is invalid. Specify a valid IP address.
400InvalidCommodityCode.MalformedThe commodity code is invalid.The commodity code is invalid.
400ArticleNotFoundArticle not foundNo relevant constraints are found.
403Forbidden.AuthenticationThe operation is forbidden by Aliyun Realname Authentication System.-
404GetCommodity.FailedGet commodity failed.Failed to obtain commodity information. The value of the CommodityCode parameter is invalid. Check the value of this parameter.
404InvalidDBInstanceName.NotFoundInvalid DBInstanceId NotFound.The instance ID cannot be found.

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

Change history

Change timeSummary of changesOperation
2022-09-13The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 403
    delete Error Codes: 404
2022-09-13The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 403
    delete Error Codes: 404