DescribePrice - 查询实例的价格 - 云数据库 RDS

该接口用于查询RDS实例的价格信息。

接口说明

适用引擎

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

rds:DescribePrice

get

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}

无

请求参数

名称	类型	必填	描述	示例值
ClientToken	string	否	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符，且该参数值中不能包含非 ASCII 字符。	ETnLKlblzczshOTUbOCz****
CommodityCode	string	否	当前实例的商品码，取值： bards：主实例按量付费（中国站） rds（默认）：主实例包年包月（中国站） rords：只读实例按量付费（中国站） rds_rordspre_public_cn：只读实例包年包月（中国站） bards_intl：主实例按量付费（国际站） rds_intl：主实例包年包月（国际站） rords_intl：只读实例按量付费（国际站） rds_rordspre_public_intl：只读实例包年包月（国际站）说明查询只读实例时必须传入本参数。	rds
RegionId	string	否	地域 ID。可调用 DescribeRegions 获取。	cn-hangzhou
Engine	string	是	数据库类型，取值： MySQL SQLServer PostgreSQL MariaDB	MySQL
EngineVersion	string	是	MySQL：5.5、5.6、5.7、8.0 SQL Server：08r2_ent_ha（云盘版，已停售）、2008r2（高性能本地盘，已停售）、2012（企业版单机）、2012_ent_ha、2012_std_ha、2012_web、2014_ent_ha、2014_std_ha、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、2022_web PostgreSQL：10.0、11.0、12.0、13.0、14.0、15.0 MariaDB：10.3 数据库版本，取值： MySQL：5.5、5.6、5.7、8.0 SQL Server：08r2_ent_ha（云盘版，已停售）、2008r2（高性能本地盘，已停售）、2012（企业版单机）、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、2022_web PostgreSQL：10.0、11.0、12.0、13.0、14.0、15.0 MariaDB：10.3 说明 SQL Server 实例中`_ent`表示企业集群版、`_ent_ha`表示企业版、`_std_ha`表示标准版、`_web`表示 Web 版。	8.0
DBInstanceClass	string	是	实例规格，详情请参见主实例规格表。	mysql.x2.medium.xc
DBInstanceStorage	integer	是	实例存储空间，单位：GB。每 5 GB 进行递增，取值范围请参见实例规格表。	20
PayType	string	否	实例的付费类型，取值： Prepaid：预付费（包年包月） Postpaid：后付费（按量付费）	Prepaid
ZoneId	string	否	主节点可用区 ID。可调用 DescribeRegions 获取。说明指定了 VPC 和交换机时，为匹配交换机对应的可用区，该参数必填。	cn-hangzhou-b
UsedTime	integer	否	指定购买时长，取值：当参数 TimeType 为 Year 时，UsedTime 取值为1~100。当参数 TimeType 为 Month 时，UsedTime 取值为1~999。默认值：1。	1
TimeType	string	否	包年包月的付费类型，当 CommodityCode 参数的值为 rds、rds_rordspre_public_cn、rds_intl或rds_rordspre_public_intl时必传。取值： Year：包年 Month：包月	Year
Quantity	integer	是	购买实例的数量，取值范围：0~30。	10
InstanceUsedType	integer	否	实例类型，取值： 0：主实例 3：只读实例	0
OrderType	string	否	订单类型，取值： BUY：购买 RENEW：续费 UPGRADE：升级 DOWNGRADE：降级	BUY
DBInstanceStorageType	string	否	实例存储类型，取值： general_essd：高性能云盘 local_ssd：高性能本地盘 cloud_ssd：SSD 云盘 cloud_essd：ESSD PL1 云盘 cloud_essd2：ESSD PL2 云盘 cloud_essd3：ESSD PL3 云盘	local_ssd
DBInstanceId	string	否	变配或续费的实例 ID。说明需要查询实例变配或续费价格时需要传入该参数。如果为只读实例，则需要传入其主实例的 ID。	rm-****
DBNode	array<object>	否	节点相关信息。说明该参数用于 MySQL 集群系列实例。
	object	否	节点详情。
ClassCode	string	否	节点规格。	mysql.x2.medium.xc
ZoneId	string	否	节点可用区 ID。	cn-hangzhou-j
ServerlessConfig	object	否	RDS Serverless 实例的相关设置。说明 MariaDB 不支持 Serverless 实例。
MaxCapacity	number	否	实例 RCU（RDS Capacity Unit）的自动扩缩范围最大值。	8
MinCapacity	number	否	实例 RCU（RDS Capacity Unit）的自动扩缩范围最小值。	0.5

返回参数

名称	类型	描述	示例值
	object	返回参数详情。
OrderParams	string	订单参数。说明仅当 OrderParamOut 参数传入 true 时，返回该参数。	{\"autoPay\":false}"
PriceInfo	object	价格信息。
ActivityInfo	object	价格信息。
CheckErrMsg	string	错误描述。	Error description
ErrorCode	string	错误代码。	123456
Success	string	是否成功。	Success
Coupons	object
Coupon	array<object>	优惠信息列表。
	object	优惠详情信息。
CouponNo	string	优惠券编号。	123456
Description	string	优惠券描述。	test
IsSelected	string	是否已选择优惠券。	true
Name	string	优惠券名称。	test
Currency	string	货币单位。	CNY
DiscountPrice	number	折扣。	0
OrderLines	any	订单信息。	Order Information
OriginalPrice	number	原价。	10508
RuleIds	object
RuleId	array	活动 ID 列表。
	string	活动 ID。	100119****
TradeMaxRCUAmount	number	根据用户所选择的最大 RCU 计算出的每小时费用预估。	1**
TradeMinRCUAmount	number	根据用户所选择的最小 RCU 计算出的每小时费用预估。	2**
TradePrice	number	最终价，为原价减去折扣。	10508
RequestId	string	请求 ID。	CA0ADDDC-0BEB-4381-A3ED-73B4C79B8CC6
Rules	object
Rule	array<object>	活动规格列表。
	object	活动详细。
Description	string	活动描述。	Activity Description
Name	string	活动名称。	Rule1
RuleId	integer	活动 ID。	102002100393****
ServerlessPrice	object	Serverless 价格信息。
RCUDiscountMaxAmount	number	maxRCU 优惠金额。	1*.
RCUDiscountMinAmount	number	minRCU 优惠金额。	1.
RCUOriginalMaxAmount	number	maxRCU 价格。	2*.
RCUOriginalMinAmount	number	minRCU 价格。	3.
StorageOriginalAmount	number	磁盘原始价格。	1*
TotalOriginalMaxAmount	number	优惠前总价最大值。	2*.
TotalOriginalMinAmount	number	优惠前总价最小值。	2.
TradeMaxRCUAmount	number	maxRCU 交易价格。	1*.
TradeMinRCUAmount	number	minRCU 交易价格。	2.
storageDiscountAmount	number	磁盘折扣价格。	2.*
ShowDiscount	boolean	是否允许使用折扣。	true
TradeMaxRCUAmount	number	根据用户所选择的最大 RCU 计算出的每小时费用预估。	2**
TradeMinRCUAmount	number	根据用户所选择的最小 RCU 计算出的每小时费用预估。	1**

示例

正常返回示例

JSON格式

{
  "OrderParams": "{\\\"autoPay\\\":false}\"\n",
  "PriceInfo": {
    "ActivityInfo": {
      "CheckErrMsg": "Error description",
      "ErrorCode": " 123456",
      "Success": "Success"
    },
    "Coupons": {
      "Coupon": [
        {
          "CouponNo": "123456",
          "Description": "test",
          "IsSelected": "true",
          "Name": "test"
        }
      ]
    },
    "Currency": "CNY",
    "DiscountPrice": 0,
    "OrderLines": "Order Information",
    "OriginalPrice": 10508,
    "RuleIds": {
      "RuleId": [
        "100119****"
      ]
    },
    "TradeMaxRCUAmount": 0,
    "TradeMinRCUAmount": 0,
    "TradePrice": 10508
  },
  "RequestId": "CA0ADDDC-0BEB-4381-A3ED-73B4C79B8CC6",
  "Rules": {
    "Rule": [
      {
        "Description": "Activity Description",
        "Name": "Rule1",
        "RuleId": 0
      }
    ]
  },
  "ServerlessPrice": {
    "RCUDiscountMaxAmount": 0,
    "RCUDiscountMinAmount": 0,
    "RCUOriginalMaxAmount": 0,
    "RCUOriginalMinAmount": 0,
    "StorageOriginalAmount": 0,
    "TotalOriginalMaxAmount": 0,
    "TotalOriginalMinAmount": 0,
    "TradeMaxRCUAmount": 0,
    "TradeMinRCUAmount": 0,
    "storageDiscountAmount": 0
  },
  "ShowDiscount": true,
  "TradeMaxRCUAmount": 0,
  "TradeMinRCUAmount": 0
}

错误码

HTTP status code	错误码	错误信息	描述
400	DBInstanceStorageFormatFault	DBInstanceStorageFormatFault
400	InvalidDBInstanceStorage.Format	InvalidDBInstanceStorage.Format	实例存储大小不符合要求，请检查。
400	DBNodeParameter.InvalidClassCode	The ClassCode of the item of the specified parameter DBNode is inconsistent.	参数DBNode中的ClassCode配置不一致。
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.	该请求未提及正确的订购期限。请检查您的Period或UsedTime参数。
400	Price.HsfTimeoutError	Inquiry error.	询价错误。
400	Rule.HsfTimeoutError	Request rule service error.	请求规则服务错误。
400	InvalidDBInstanceClassNotFound	Specified DB instance class is not found.	指定的实例不存在或不支持
400	System.SaleValidateFailed	Sales expression validation system error.	销售表达式校验系统错误。
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	套餐实例不允许单独操作。
400	Price.PricingPlanResultNotFound	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.	您还未通过实名认证，不符合购买条件，请登录费用与成本进行实名认证。
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	您的账户可用额度小于0，请先充值后再尝试购买。
400	CommodityServiceCalling.Exception	Failed to call commodity service.	调用商品服务返回失败。
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.	客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	您购买的模块不合法，请重新购买。
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.	客户您好，该地域已裁撤。
400	Price.CommoditySys	Commodity system call exception.	商品系统调用异常。
400	Pay.InsufficientBalance	Insufficient available balance.	可用金不足。
400	Order.PeriodInvalid	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.	您选购的服务存在未支付订单，请支付或作废后再下单。
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.	您的基本信息未完善，请在操作前先完善您的基本信息。
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	您的账户出现异常，详情请联系客服。
400	Api.NotSupport	Specified api is not supported.	当前接口不支持。
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	存在禁止下单的标签，请联系您的分销商处理
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	提供的DBInstanceId不存在。
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	当前实例规格不支持该存储类型。
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	指定的 wal_level 参数无效。实例中仍然存在复制槽，因此无法将其设置为replica。
400	KmsApiError	User secret key invalid.	用户密钥失效。
400	Abs.InvalidAccount.NotFound	account is not found.	账户不存在。
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	sql命令执行失败或执行超时
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	当前实例引擎版本不支持归档冷数据。
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	当前内核版本不支持归档冷数据。
400	IncorrectTargetClasscode	The current instance type does not support this operation.	当前规格不支持此操作。
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	链接地址名重复，请重新设置连接字符串。
400	RequiredParam.NotFound	Required input param is not found.	没有传入必要的参数。
400	Parameters.Invalid	Parameter error, please check the parameters.	参数错误，请检查参数。
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	数据归档不支持跨地域备份和秒级快照，请检查备份策略。
400	InvalideStatus.Format	The instance status does not support this operation.	实例状态不支持此操作。
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	实例释放后的归档备份保留策略无效。
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	DB实例引擎类型不支持此操作。
400	Pay.NoCreditCard	No credit cards.	无信用卡。
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	vpc网络类型实例不支持此操作。
400	MirrorInsExists	Specified DB instance mirror ins already existed.	当前数据库实例镜像已存在。
400	UnsupportedClassCode	The specified DB instance class stops selling.	实例规格停止售卖。
400	InvalidBackupSet	The specified database does not exist in the backup set.	备份集中没有指定的数据库。
400	OrdTCommodityQueryError	Failed to query for product.	查询产品失败。
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	实例已释放，请核实后下单。
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	指定的地域无效。
400	DBNodeFormatFault	The specified parameter DBNode is malformed	dbNode格式不正确
400	DBNodeParameter.Required	The DBNode parameter is required for RDS for MySQL Cluster Edition instances.	RDS MySQL集群系列实例，参数DBNode为必填项。
400	DBNodeParameter.TooFewItems	You must configure at least 2 nodes in the DBNode parameter value for RDS for MySQL Cluster Edition instances.	RDS MySQL集群系列实例，参数DBNode最少需配置2个节点。
400	DBNodeParameter.TooManyItems	You can configure up to 9 nodes in the DBNode parameter value for RDS for MySQL Cluster Edition instances.	RDS MySQL集群系列实例，参数DBNode最大支持配置9个节点。
500	ExternalFailure	The request processing has failed due to external service failure.	请求服务失败，请稍后重试。
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	请求服务失败，请稍后再试或联系服务人员。
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	由于rds api服务失败，请求处理失败。
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.	账户没有指定付款方式.
403	RegionDissolvedInduEOFS	Alibaba Cloud plans to optimize and adjust the region in India. Cloud services in this region will stop operating. you are currently unable to operate new purchase, renewal, and configuration change orders.	客户您好，阿里云计划对印度地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购、续费、变配类型的订单，感谢理解与支持。
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	实例当前存在未支付订单，请支付后重试。
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	缩容目标容量不能小于当前存储空间使用量
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	SSD盘不支持此操作，请升级至ESSD。
403	InvalidUserOperatorPermission	The user permission does not support this operation.	用户权限不支持此操作。
403	InvalidVswitchId	Specified conn vswitch id is not valid.	指定的VSwitchId格式不正确或为空
403	IncorrectMinorVersion	Current engine minor version does not support operations.	当前引擎小版本不支持此操作。
403	OperationDenied.ZoneResource	There is no available zone for inventory.	没有可用的库存区域。
403	NotInFlowController	Sorry,no permission.	非集团上云用户不可用，无权限。
403	InvalidKmsKey	Kms key is disabled.	Kms key已禁用。
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	当前数据库实例级别不支持此操作。
404	InvalidTimeType.NotFound	The parameter timeType does not exist.	请检查 TimeType 参数。可选值为 Year、Month、Day
404	canNotFindSubscription	Subscription information not found.	找不到订购信息。
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	当前实例未授权访问密钥管理服务。
404	Request.NotFound	The requested resource is not available.	请求的资源不可用。
404	HostInfo.NotFound	The specified host info is not found.	指定的主机信息不存在。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。