All Products
Search
Document Center

ApsaraDB RDS:DescribeAvailableClasses

Last Updated:Mar 30, 2023

You can call the DescribeAvailableClasses operation to query the specifications that are supported for an instance. The specifications include the instance type and the storage capacity.

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 keyAssociation operation
rds:DescribeAvailableClassesREAD
  • RDS
    acs:rds:{#regionId}:{#accountId}:dbinstance/*
  • 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 an instance.

cn-hangzhou
ZoneIdstringYes

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

NoteIf 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 the ZoneId 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
Prepaid
EnginestringYes

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

  • MySQL
  • SQLServer
  • PostgreSQL
  • MariaDB
MySQL
EngineVersionstringYes

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

  • Values that are valid if you set the Engine parameter to MySQL: 5.5, 5.6, 5.7, and 8.0
  • Values that are valid if you set the Engine parameter to SQL Server: 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
  • Values that are valid if you set the Engine parameter to PostgreSQL: 10.0, 11.0, 12.0, 13.0 and 14.0
  • Values that are valid if you set the Engine parameter to MariaDB: 10.3
8.0
DBInstanceIdstringNo

The ID of the instance.

rm-uf6wjk5xxxxxx
OrderTypestringNo

The type of the order. Set the value to BUY

BUY
DBInstanceStorageTypestringYes

The type of storage media that is used for the instance. Valid values:

  • local_ssd: local SSDs. This is the recommended storage type.
  • cloud_ssd: standard SSDs.
  • cloud_essd: enhanced SSDs (ESSDs) of performance level 1 (PL1).
  • cloud_essd2: ESSDs of PL2.
  • cloud_essd3: ESSDs of PL3.
local_ssd
CategorystringYes

The RDS edition that is run by the instance. Valid values:

  • Basic: Basic Edition
  • HighAvailability: High-availability Edition
  • AlwaysOn: Cluster Edition
  • Finance: Enterprise Edition
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 on the China site (aliyun.com).
  • rds: The instance is a subscription primary instance. This value is available on the China site (aliyun.com).
  • rords: The instance is a pay-as-you-go read-only instance. This value is available on the China site (aliyun.com).
  • rds_rordspre_public_cn: The instance is a subscription read-only instance. This value is available on the China site (aliyun.com).
  • bards_intl: The instance is a pay-as-you-go primary instance. This value is available on the International site (alibabacloud.com).
  • rds_intl: The instance is a subscription primary instance. This value is available on the International site (alibabacloud.com).
  • rords_intl: The instance is a pay-as-you-go read-only instance. This value is available on the International site (alibabacloud.com).
  • rds_rordspre_public_intl: The instance is a subscription read-only instance. This value is available on the International site (alibabacloud.com).
NoteIf the instance is a read-only instance, you must specify the CommodityCode parameter.
bards

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC
DBInstanceClassesarray

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

object
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