调用DescribePrice接口查询RDS实例的价格。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribePrice

系统规定参数。取值：DescribePrice。

ClientToken String 否 ETnLKlblzczshOTUbOCz*****

用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。
CommodityCode String 否 rds

当前实例的商品码，取值：

  • bards：主实例按量付费（中国站）
  • rds（默认）：主实例包年包月（中国站）
  • rords：只读实例按量付费（中国站）
  • rds_rordspre_public_cn：只读实例包年包月（中国站）
  • bards_intl：主实例按量付费（国际站）
  • rds_intl：主实例包年包月（国际站）
  • rords_intl：只读实例按量付费（国际站）
  • rds_rordspre_public_intl：只读实例包年包月（国际站）
说明 查询只读实例时必须传入本参数。
RegionId String 是 cn-hangzhou

地域ID。可以通过接口DescribeRegions查看地域ID。

Engine String 是 MySQL

数据库类型，取值：

  • MySQL
  • SQLServer
  • PostgreSQL
  • MariaDB
EngineVersion String 是 5.5

数据库版本，取值：

  • MySQL：5.5、5.6、5.7、8.0
  • SQL Server：2008r2、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、2019_ent
  • PostgreSQL：10.0、11.0、12.0、13.0、14.0
  • MariaDB：10.3
DBInstanceClass String 是 rds.mysql.s1.small

实例规格，详情请参见主实例规格表。

DBInstanceStorage Integer 是 20

实例存储空间，单位：GB。每5 GB进行递增，取值范围请参见实例规格表。

PayType String 否 Prepaid

实例的付费类型，取值：

  • Prepaid：预付费（包年包月）
  • Postpaid：后付费（按量付费）
ZoneId String 否 cn-hangzhou-b

主节点可用区ID。可以通过接口DescribeRegions查看可用区ID。

说明 指定了VPC和交换机时，为匹配交换机对应的可用区，该参数必填。
UsedTime Integer 否 1

指定购买时长，取值：

  • 当参数TimeType为Year时，UsedTime取值为1~100。
  • 当参数TimeType为Month时，UsedTime取值为1~999。

默认值：1。

TimeType String 否 Year

包年包月的付费类型，当CommodityCode参数的值为RDS、rds_rordspre_public_cn、rds_intl或rds_rordspre_public_intl时必传。取值：

  • Year：包年
  • Month：包月
Quantity Integer 是 10

购买实例的数量，取值范围：0~30。

InstanceUsedType Integer 否 0

实例类型，取值：

  • 0：主实例
  • 3：只读实例
OrderType String 否 BUY

订单类型，取值：

  • BUY：购买
  • UPGRADE：变配
  • RENEW：续费
DBInstanceStorageType String 否 local_ssd

实例存储类型，取值：

  • local_ssd：本地SSD盘
  • cloud_ssd：SSD云盘
  • cloud_essd：ESSD PL1云盘
  • cloud_essd2：ESSD PL2云盘
  • cloud_essd3：ESSD PL3云盘
DBInstanceId String 否 rm-*****

变配或续费的实例ID。

说明 需要查询实例变配或续费价格时需要传入该参数。

返回数据

名称 类型 示例值 描述
RequestId String CA0ADDDC-0BEB-4381-A3ED-73B4C79B8CC6

请求ID。
PriceInfo Object

价格信息。
OriginalPrice Float 2504

原价。
DiscountPrice Float 0

折扣。
Currency String CNY

货币单位。
TradePrice Float 2504

最终价，为原价减去折扣。
Coupons Array of Coupon

优惠信息列表。
Coupon
IsSelected String true

是否已选择优惠券。
CouponNo String 123456

优惠券编号。
Name String test

优惠券名称。
Description String test

优惠券描述。
RuleIds Array of String 1001199213

活动ID。
ActivityInfo Object

价格信息。
CheckErrMsg String Error description

错误描述。
ErrorCode String 123456

错误代码。
Success String Success

是否成功。
Rules Array of Rule

活动规格列表。
Rule
Name String Rule1

活动名称。
Description String Activity Description

活动描述。
RuleId Long 1020021003939076

活动ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribePrice
&DBInstanceClass=rds.mysql.s1.small
&DBInstanceStorage=200
&Engine=MySQL
&EngineVersion=5.7
&Quantity=1
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-h
&PayType=Prepaid
&UsedTime=1
&TimeType=Month
&<公共请求参数>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribePriceResponse>
<RequestId>CA0ADDDC-0BEB-4381-A3ED-73B4C79B8CC6</RequestId>
<Rules>
</Rules>
<PriceInfo>
    <OriginalPrice>2504</OriginalPrice>
    <Currency>CNY</Currency>
    <DiscountPrice>0</DiscountPrice>
    <RuleIds>
    </RuleIds>
    <TradePrice>2504</TradePrice>
    <Coupons>
    </Coupons>
</PriceInfo>
</DescribePriceResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CA0ADDDC-0BEB-4381-A3ED-73B4C79B8CC6",
  "Rules" : {
    "Rule" : [ ]
  },
  "PriceInfo" : {
    "OriginalPrice" : 2504,
    "Currency" : "CNY",
    "DiscountPrice" : 0,
    "RuleIds" : {
      "RuleId" : [ ]
    },
    "TradePrice" : 2504,
    "Coupons" : {
      "Coupon" : [ ]
    }
  }
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidDBInstanceStorage.Format InvalidDBInstanceStorage.Format 实例存储大小不符合要求，请检查。
404 InvalidTimeType.NotFound The parameter timeType does not exist. 请检查 TimeType 参数。可选值为 Year、Month、Day

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