DescribePrice - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the price 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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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: 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 is the default value. 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 on the International site (alibabacloud.com). 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 SQLServer PostgreSQL MariaDB	MySQL
EngineVersion	string	Yes	The database engine version of the 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: 08r2_ent_ha (cloud disks, discontinued), 2008r2(local disks, discontinued), 2012 (SQL Server EE Basic), 2012_ent_ha, 2012_std_ha, 2012_web, 2016_ent_ha, 2016_std_ha, 2016_web, 2017_ent, 2017_std_ha, 2017_web, 2019_ent, 2019_std_ha, 2019_web, 2022_ent, 2022_std_ha, and 2022_web Valid values if you set Engine to PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, and 15.0 Valid value if you set Engine to MariaDB: 10.3 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: subscription Postpaid: pay-as-you-go	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. If you set the TimeType parameter to Year, the value of the UsedTime parameter ranges from 1 to 100. If you set the TimeType parameter to Month, the value of the UsedTime parameter ranges from 1 to 999. 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 Month	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: primary instance 3: read-only instance	0
OrderType	string	No	The order type. Valid values: BUY: purchase order UPGRADE: specification change order RENEW: renewal order	BUY
DBInstanceStorageType	string	No	The storage type of the instance. Valid values: local_ssd: local SSD cloud_ssd: standard SSD cloud_essd: PL1 ESSD cloud_essd2: PL2 ESSD cloud_essd3: PL3 ESSD	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 If you want to query the price of a specification change order or a renewal order, you must specify this parameter. If the instance is a read-only instance, you must set this parameter to the ID of its primary instance.	rm-*****
DBNode	array<object>	No	The information about the node. Note This parameter is supported for ApsaraDB RDS for MySQL instances that run RDS Cluster Edition.
	object	No	The details of the node.
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

Parameter	Type	Description	Example
	object	The response parameters.
OrderParams	string	The order parameters. Note If the OrderParamOut parameter is set to true, the value of the OrderParams parameter is returned.	{\"autoPay\":false}"
RequestId	string	The ID of the request.	CA0ADDDC-0BEB-4381-A3ED-73B4C79B8CC6
PriceInfo	object	The price information.
OriginalPrice	float	The original price.	2504
DiscountPrice	float	The discount.	0
Currency	string	The currency unit.	CNY
TradePrice	float	The transaction price, which is equal to the original price minus the discount.	2504
TradeMinRCUAmount	float	The estimated hourly cost that is calculated based on the minimum number of RCUs you specify.	2**
TradeMaxRCUAmount	float	The estimated hourly cost that is calculated based on the maximum number of RCUs you specify.	1**
Coupons	array<object>	The information about the coupon.
	object	The information about the coupon.
IsSelected	string	Indicates whether the coupon is selected.	true
CouponNo	string	The coupon ID.	123456
Name	string	The coupon name.	test
Description	string	The description of the coupon.	test
RuleIds	array	An array that consists of the ID of the promotion rule.
	string	The ID of the promotion rule.	1001199213
ActivityInfo	object	The information about the promotion.
CheckErrMsg	string	The returned message.	Error description
ErrorCode	string	The error code that is returned.	123456
Success	string	Indicates whether the request was successful.	Success
OrderLines	string	The order information.	Order Information
Rules	array<object>	The details of the promotion rule.
	object	The details of the promotion rule.
Name	string	The name of the promotion rule.	Rule1
Description	string	The description of the promotion rule.	Activity Description
RuleId	long	The ID of the promotion rule.	1020021003939076
ShowDiscount	boolean	Indicates whether discounts can be used.	True
TradeMaxRCUAmount	float	The estimated hourly fee that is calculated based on the maximum number of RCUs.	2**
TradeMinRCUAmount	float	The estimated hourly fee that is calculated based on the minimum number of RCUs.	1**
ServerlessPrice	object	The pricing information about a serverless RDS instance.
TotalOriginalMinAmount	float	The minimum total price before the discount.	2.
TotalOriginalMaxAmount	float	The maximum total price before the discount.	2*.
RCUOriginalMinAmount	float	The price of the minimum number of RCUs.	3.
RCUOriginalMaxAmount	float	The price of the maximum number of RCUs.	2*.
RCUDiscountMinAmount	float	The discount amount of the minimum number of RCUs.	1.
RCUDiscountMaxAmount	float	The discount amount of the maximum number of RCUs.	1*.
TradeMinRCUAmount	float	The transaction price of the minimum number of RCUs.	2.
TradeMaxRCUAmount	float	The transaction price of the maximum number of RCUs.	1*.
StorageOriginalAmount	float	The original price of the disk capacity.	1*
storageDiscountAmount	float	The discounted price of the disk capacity.	2.*

Examples

Sample success responses

JSONformat

{
  "OrderParams": "{\\\"autoPay\\\":false}\"\n",
  "RequestId": "CA0ADDDC-0BEB-4381-A3ED-73B4C79B8CC6",
  "PriceInfo": {
    "OriginalPrice": 2504,
    "DiscountPrice": 0,
    "Currency": "CNY",
    "TradePrice": 2504,
    "TradeMinRCUAmount": 0,
    "TradeMaxRCUAmount": 0,
    "Coupons": {
      "Coupon": [
        {
          "IsSelected": "true",
          "CouponNo": "123456",
          "Name": "test",
          "Description": "test"
        }
      ]
    },
    "RuleIds": {
      "RuleId": [
        "1001199213"
      ]
    },
    "ActivityInfo": {
      "CheckErrMsg": "Error description",
      "ErrorCode": " 123456",
      "Success": "Success"
    },
    "OrderLines": "Order Information"
  },
  "Rules": {
    "Rule": [
      {
        "Name": "Rule1",
        "Description": "Activity Description",
        "RuleId": 1020021003939076
      }
    ]
  },
  "ShowDiscount": true,
  "TradeMaxRCUAmount": 0,
  "TradeMinRCUAmount": 0,
  "ServerlessPrice": {
    "TotalOriginalMinAmount": 0,
    "TotalOriginalMaxAmount": 0,
    "RCUOriginalMinAmount": 0,
    "RCUOriginalMaxAmount": 0,
    "RCUDiscountMinAmount": 0,
    "RCUDiscountMaxAmount": 0,
    "TradeMinRCUAmount": 0,
    "TradeMaxRCUAmount": 0,
    "StorageOriginalAmount": 0,
    "storageDiscountAmount": 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
400	System.SaleValidateFailed	Sales expression validation system error.	A system error occurs when the sales expression is verified.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You 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 user center for real-name authentication.
400	InsufficientAvailableQuota	Your 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.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Failed to call commodity service return.
400	RegionDissolvedEOM	Dear 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.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedIndia	Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.	Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.
400	RegionEndTimeDissolvedAustralia	Cloud 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.
400	Price.CommoditySys	Commodity system call exception.	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.	-
400	Order.InstHasUnpaidOrder	There 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.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	-
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is not complete, please complete your basic information before operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Your account is abnormal, please contact customer service for details.
400	BasicInfoUncompleted	Your information is incomplete, Complete your information before the operation.	-
400	Api.NotSupport	Specified api is not supported.	The current interface does not support.
400	ContainForbiddenLabelError	There 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.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	The DBInstanceId provided does not exist.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	The current instance type does not support the specified storage type.
400	InvalidParam	Sepcified 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.
400	KmsApiError	User secret key invalid.	The user key is invalid.
400	Abs.InvalidAccount.NotFound	account is not found.	The account does not exist.
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.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.
403	InvalidReduceDiskSize	The 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
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	-
403	InvalidUserOperatorPermission	The user permission does not support this operation.	The user is not authorized to perform this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.	-
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.	-
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	The instance does not have permissions to access Key Management Service (KMS).
500	ExternalFailure	The request processing has failed due to external service failure.	The request processing has failed due to external service failure.

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

Change history

Change time	Summary of changes	Operation
2024-05-24	The Error code has changed	View Change Details
2024-04-11	The Error code has changed. The response structure of the API has changed	View Change Details
2023-11-17	The Error code has changed	View Change Details
2023-09-08	The Error code has changed	View Change Details
2023-07-03	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-05-24	The Error code has changed. The response structure of the API has changed	View Change Details
2023-05-12	The Error code has changed	View Change Details