All Products
Search
Document Center

ApsaraDB RDS:DescribeAvailableClasses

Last Updated:Jan 18, 2024

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

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:DescribeAvailableClassesREAD
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the region ID of the instance.

cn-hangzhou
ZoneIdstringYes

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
InstanceChargeTypestringYes

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
EnginestringYes

The database engine that is run by the instance. Valid values:

  • MySQL
  • SQLServer
  • PostgreSQL
  • MariaDB
MySQL
EngineVersionstringYes

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
DBInstanceIdstringNo

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

rm-uf6wjk5xxxxxx
OrderTypestringNo

The type of the order. Set the value to BUY

BUY
DBInstanceStorageTypestringYes

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
CategorystringYes

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
CommodityCodestringNo

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

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC
DBInstanceClassesobject []

An array that consists of the instance types available for the instance.

DBInstanceClassstring

The instance type of the instance.

rds.mysql.c1.large
DBInstanceStorageRangeobject

The storage capacity range that is supported for the instance.

Stepinteger

The minimum step size at which you can adjust the storage capacity of the instance. The minimum step size is 5 GB.

5
MinValueinteger

The minimum storage capacity that is supported for the instance. Unit: GB.

5
MaxValueinteger

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

HTTP status codeError codeError messageDescription
400ArticleNotFoundArticle not foundNo relevant constraints are found.
404InvalidDBInstanceName.NotFoundDBInstanceName not found-
404InvalidCondition.NotFoundNo class foundThe operation failed. The condition of the available class is invalid.

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

Change history

Change timeSummary of changesOperation
No change history