Queries the price of an instance.
Operation description
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ClientToken | string | No | 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. | ETnLKlblzczshOTUbOCz***** |
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.
| rds |
RegionId | string | Yes | The region ID. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
Engine | string | Yes | The database engine of the instance. Valid values:
| MySQL |
EngineVersion | string | Yes | The database engine version of the instance.
Note
The following information describes the valid values when you set Engine to SQLServer: _ent specifies SQL Server EE on RDS Cluster Edition, _ent_ha specifies SQL Server EE, _std_ha specifies SQL Server SE, and _web specifies SQL Server Web.
| 5.5 |
DBInstanceClass | string | Yes | The instance type of the instance. For more information, see Primary ApsaraDB RDS instance types. | rds.mysql.s1.small |
DBInstanceStorage | integer | Yes | The storage capacity of the instance. Unit: GB. You can increase the storage capacity at a step size of 5 GB. For more information, see Primary ApsaraDB RDS instance types. | 20 |
PayType | string | No | The billing method of the instance. Valid values:
| Prepaid |
ZoneId | string | No | The zone ID of the primary instance. You can call the DescribeRegions operation to query the most recent zone list. Note
If you specify a virtual private cloud (VPC) and a vSwitch, this parameter is required to identify the zone for the vSwitch.
| cn-hangzhou-b |
UsedTime | integer | No | The subscription duration of the instance.
Default value: 1. | 1 |
TimeType | string | No | The billing cycle of the subscription instance. This parameter is required when CommodityCode is set to rds, rds_rordspre_public_cn, rds_intl, or rds_rordspre_public_intl. Valid values:
| Year |
Quantity | integer | Yes | The number of instances that you want to purchase. Valid values: 0 to 30. | 10 |
InstanceUsedType | integer | No | The role of the instance. Valid values:
| 0 |
OrderType | string | No | The order type. Valid values:
| BUY |
DBInstanceStorageType | string | No | The storage type of the instance. Valid values:
| local_ssd |
DBInstanceId | string | No | The ID of the instance for which you want to change the specifications or the instance that you want to renew. Note
| rm-***** |
DBNode | object [] | No | The information about the node. Note
This parameter is supported for ApsaraDB RDS for MySQL instances that run RDS Cluster Edition.
| |
ClassCode | string | No | The instance type of the node. | mysql.n2.small.xc |
ZoneId | string | No | The zone ID of the node. | cn-hangzhou-j |
ServerlessConfig | object | No | The settings of the serverless instance. Note
ApsaraDB RDS for MariaDB does not support serverless instances.
| |
MaxCapacity | double | No | The maximum number of RDS Capacity Units (RCUs). | 8 |
MinCapacity | double | No | The minimum number of RCUs. | 0.5 |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "CA0ADDDC-0BEB-4381-A3ED-73B4C79B8CC6",
"PriceInfo": {
"OriginalPrice": 2504,
"DiscountPrice": 0,
"Currency": "CNY",
"TradePrice": 2504,
"Coupons": {
"Coupon": [
{
"IsSelected": "true",
"CouponNo": "123456",
"Name": "test",
"Description": "test"
}
]
},
"RuleIds": {
"RuleId": [
"1001199213"
]
},
"ActivityInfo": {
"CheckErrMsg": "Error description",
"ErrorCode": " 123456",
"Success": "Success"
}
},
"Rules": {
"Rule": [
{
"Name": "Rule1",
"Description": "Activity Description",
"RuleId": 1020021003939076
}
]
},
"ShowDiscount": true,
"TradeMaxRCUAmount": 0,
"TradeMinRCUAmount": 0
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | DBInstanceStorageFormatFault | DBInstanceStorageFormatFault | - |
400 | InvalidDBInstanceStorage.Format | InvalidDBInstanceStorage.Format | The storage capacity is invalid. Check the storage capacity. |
400 | DBNodeParameter.InvalidClassCode | The ClassCode of the item of the specified parameter DBNode is inconsistent. | The ClassCode configuration is invalid for the DBNode parameter. |
400 | DBNodeParameter.Required | The specified parameter DBNode is required. | You must specify the DBNode parameter. |
400 | DBNodeParameter.TooFewItems | The specified parameter DBNode has too few items. | A small number of DBNode parameter items are configured. |
400 | DBNodeParameter.TooManyItems | The specified parameter DBNode has too many items. | A large number of DBNode parameter items are configured. |
400 | Price.WanHuaTong.sys | Inquiry error. | - |
400 | SYSTEM.SaleValidateFailed | The request not refer to the correct order period. please check your Period or UsedTime param. | - |
400 | Price.HsfTimeoutError | Inquiry error. | - |
400 | Rule.HsfTimeoutError | Request rule service error. | - |
400 | InvalidDBInstanceClassNotFound | Specified DB instance class is not found. | The specified instance does not exist or does not support |
403 | CASH.BOOK.INSUFFICIENT | No payment method is specified for your account. We recommend that you add a payment method or maitain a minimum prepayment balance of INR 1000. | No payment method is specified for the account. |
404 | InvalidTimeType.NotFound | The parameter timeType does not exist. | Check the TimeType parameter. Valid values: Year, Month, and Day. |
404 | canNotFindSubscription | Subscription information not found. | - |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-11-17 | The Error code has changed | see changesets | ||||||||||||||
| ||||||||||||||||
2023-09-08 | The Error code has changed | see changesets | ||||||||||||||
| ||||||||||||||||
2023-07-03 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | see changesets | ||||||||||||||
| ||||||||||||||||
2023-05-24 | The Error code has changed. The response structure of the API has changed | see changesets | ||||||||||||||
| ||||||||||||||||
2023-05-12 | The Error code has changed | see changesets | ||||||||||||||
|