All Products
Search
Document Center

ApsaraDB RDS:DescribeClassDetails

Last Updated:Sep 13, 2024

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.

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

ETnLKlblzczshOTUbOCz*****
RegionIdstringYes

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

cn-hangzhou
CommodityCodestringYes

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
ClassCodestringYes

The code of the instance type.

rds.mysql.s3.large
EngineVersionstringYes

The database engine version of the instance.

5.6
EnginestringYes

The type of the database engine.

MySQL
ResourceGroupIdstringNo

The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.

rg-acfmy*****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34
ClassCodestring

The code of the instance type.

mysql.n2.medium.1
MaxIOMBPSstring

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

1024
MaxConnectionsstring

The maximum number of connections.

4000
ClassGroupstring

The instance family of the instance.

x
Cpustring

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

4
InstructionSetArchstring

The architecture of the instance.

x86
MemoryClassstring

The memory size. Unit: GB.

2GB
MaxIOPSstring

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

N/A
ReferencePricestring

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
    Categorystring

    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
    DBInstanceStorageTypestring

    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

    HTTP status codeError codeError messageDescription
    400InvalidClassCode.NotFoundInvalid ClassCode NotFound.The operation failed because the code of the instance type does not exist.
    400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
    400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing plan price result not found.
    400Order.NoRealNameAuthenticationYou 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 cost and cost for real-name authentication.
    400InsufficientAvailableQuotaYour 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.
    400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
    400RegionDissolvedEOMDear 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.
    400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.The module you purchased is not legal, please buy it again.
    400RegionEndTimeDissolvedAustraliaCloud 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.
    400Price.CommoditySysCommodity system call exception.Commodity system call exception.
    400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
    400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There is a problem with the period you selected, please choose again.
    400pay.noCreditCardAccount not bound to credit card.-
    400Order.InstHasUnpaidOrderThere 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.
    400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.-
    400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.Your basic information is not complete, please complete your basic information before operation.
    400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.Your account is abnormal, please contact customer service for details.
    400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.-
    400Api.NotSupportSpecified api is not supported.The current interface does not support.
    400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
    400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.The DBInstanceId provided does not exist.
    400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk typeThe current instance type does not support the specified storage type.
    400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
    400KmsApiErrorUser secret key invalid.The user key is invalid.
    400System.SaleValidateFailedSales expression validation system error.A system error occurs when the sales expression is verified.
    400Abs.InvalidAccount.NotFoundaccount is not found.The account does not exist.
    400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.SQL command execution failed or timed out
    400ColdData.EngineVersionNotSupportThe current instance engine version not support coldDataEnabled.The current instance engine version not support coldDataEnabled.
    400ColdData.MinorVersionNotSupportThe current instance minor version not support coldDataEnabled.The current instance minor version not support coldDataEnabled.
    400IncorrectTargetClasscodeThe current instance type does not support this operation.This operation is not supported by the instance type.
    400InvalidConnectionString.DuplicateSpecified connection string already exists in the RDS.The link address name is duplicate. Please reset the connection string.
    400RequiredParam.NotFoundRequired input param is not found.-
    400Parameters.InvalidParameter error, please check the parameters.Parameter error, please check the parameters.
    400BackupPolicyNotSupportCold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
    400InvalideStatus.FormatThe instance status does not support this operation.-
    400InvalidReleasedKeepPolicy.FormatSpecified Released Keep Policy is not valid.Specified Released Keep Policy is not valid.
    400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.This operation is not supported for the database engine of the instance.
    400Pay.NoCreditCardNo credit cards.No credit cards.
    400VpcNetworkTypeNotSupportThe vpc network type instance does not support this operation.The vpc network type instance does not support this operation.
    400MirrorInsExistsSpecified DB instance mirror ins already existed.Specified DB instance mirror ins already existed.
    400UnsupportedClassCodeThe specified DB instance class stops selling.The specified DB instance class stops selling.
    400InvalidBackupSetThe specified database does not exist in the backup set.The specified database does not exist in the backup set.
    400OrdTCommodityQueryErrorFailed to query for product.Failed to query product.
    400ProductInstanceReleasedThe instance has been released. Please check before placing the order.The instance has been released, please verify and place an order.
    400RegionEndTimeDissolvedIndiaThe region is no longer supported.The region is no longer supported.
    403OrderStatus.UnPaidThe specified db instance has unpaid order.The instance has an unpaid order. Please pay first and try again.
    403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.The scale-in target capacity cannot be less than the current storage space usage
    403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.-
    403InvalidUserOperatorPermissionThe user permission does not support this operation.The user is not authorized to perform this operation.
    403InvalidVswitchIdSpecified conn vswitch id is not valid.-
    403IncorrectMinorVersionCurrent engine minor version does not support operations.This operation is not supported for the current minor engine version.
    403OperationDenied.ZoneResourceThere is no available zone for inventory.There is no available zone for inventory.
    403NotInFlowControllerSorry,no permission.Sorry,no permission.
    403InvalidKmsKeyKms key is disabled.-
    403InvalidInstanceLevel.MalformedCurrent DB instance level does not support this operation.The specified database instance type does not support this operation.
    404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.The instance does not have permissions to access Key Management Service (KMS).
    404Request.NotFoundThe requested resource is not available.The requested resources are unavailable.
    404HostInfo.NotFoundThe specified host info is not found.-
    500ExternalFailureThe request processing has failed due to external service failure.The request processing has failed due to external service failure.
    500RequestMetaDataFailedThe service request failed. Please try again later or contact service personnel.The service request failed. Please try again later or contact service personnel.
    500InvokeProxyFailureThe request processing has failed due to service failure of rds api.The request failed to be processed due to an RDS API failure.

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

    Change history

    Change timeSummary of changesOperation
    2023-07-25The Error code has changed. The request parameters of the API has changedView Change Details