调用DescribePrice查询创建Redis实例、升级配置或续费等操作产生的费用。

调试

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

请求参数

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

系统规定参数,取值:DescribePrice。

OrderType Query String BUY

订单类型,可选值:

  • BUY(购买)
  • UPGRADE(变配)
  • RENEW(续费)
RegionId Host String cn-hangzhou

地域ID,可调用DescribeRegions查询。

InstanceId Query String r-bp1xxxxxxxxxxxxx

实例ID。

Capacity Query Long 1024

使用实例的存储容量指定规格,单位:MB。您需要在InstanceClass和Capacity参数中二选一,用来指定查询的规格。建议您使用InstanceClass参数精确地指定一个规格。

InstanceClass Query String redis.master.small.default

使用InstanceClass编码指定实例规格。您需要在InstanceClass和Capacity参数中二选一,用来指定查询的规格。建议您使用InstanceClass参数精确地指定一个规格。

InstanceClass查询步骤:

1. 在规格查询导航中,根据需要选择实例类型,点击其架构类型列以打开规格文档。

2. 在规格文档的实例规格表中,选择需要的实例规格,并找到其InstanceClass列的编码。

ZoneId Query String cn-hangzhou-e

可用区ID,可调用DescribeZones查询。

ChargeType Query String PostPaid

付费类型,可选值:

  • PostPaid(按量付费)
  • PrePaid(包年包月)
说明 默认值:PostPaid
NodeType Query String MASTER_SLAVE

节点类型,唯一值:MASTER_SLAVE,表示主从双副本。

Period Query Long 3

包年包月时长,单位为月。取值范围:1~9、12、24、36。

Quantity Query Long 1

购买实例的数量,取值范围:1~30。默认值:1。

Instances Query String Instances=[{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","InstanceClass": "redis.master.small.default","ChargeType": "PostPaid","OrderType": "BUY","Period": "1","Quantity": "1","Capacity": "4096"}]

包含多个实例的JSON格式字符串,设置方式请参见Instances的格式说明

BusinessInfo Query String 000000000000

活动ID、业务信息等扩展信息。

CouponNo Query String youhuiquan_promotion_option_id_for_blank

优惠码,默认值:youhuiquan_promotion_option_id_for_blank,表示无优惠码。

ForceUpgrade Query Boolean true

是否强制变配,可选值:

  • false(是)
  • true(否)
说明 默认值:true
OrderParamOut Query String "{\"autoPay\":false,\"autoUseCoupon\":false,\"bid\":\"26842\",\"buyerId\":xxxxxxxxxxxxxxx,\"commodities\":[{\"chargeType\":\"POSTPAY\",\"commodityCode\":\"kvstore\",\"components\":[{\"componentCode\":\"kvstore_instance_class\",\"free\":false,\"moduleAttrStatus\":1,\"moduleParams\":{},\"properties\":[{\"code\":\"kvstore_instance_class\",\"name\":\"redis.master.small.default\",\"value\":\"redis.master.small.default\"}]},{\"componentCode\":\"kvstore_region_no\",\"free\":false,\"moduleAttrStatus\":1...

是否返回订单参数,可选值:

  • false(不返回)
  • true(返回)
说明 默认值:false

返回数据

名称 类型 示例值 描述
Order Struct

订单信息。

Coupons Array of Coupon

优惠券信息。

Coupon
CouponNo String youhuiquan_promotion_option_id_for_blank

优惠券编码。

Description String coupondemo

备注。

IsSelected String true

是否选中该优惠券。

Name String 内部结算用户0元付

订单实际交易价。

Currency String CNY

币种。

DiscountAmount Float 0.21

订单优惠金额。

OriginalAmount Float 0.21

订单原价。

RuleIds List RuleId: 1111111111

命中策略的ID。

TradeAmount Float 10

订单实际交易价。

SubOrders Array of SubOrder

优惠券对应的策略。

SubOrder
DiscountAmount Float 0.21

订单优惠金额。

InstanceId String r-bp1xxxxxxxxxxxxx

实例ID。

OriginalAmount Float 0.21

订单原价。

RuleIds List RuleId: 1111111111

命中策略的ID。

TradeAmount Float 10

订单实际交易价。

Rules Array of Rule

活动规则。

Rule
Name String 内部结算用户0元付

订单实际交易价。

RuleDescId Long 1111111111

策略ID。

Title String demo

策略标题。

RequestId String 3A40BE4E-1890-4972-889C-FEFA37663635

请求ID。

OrderParams String String

订单参数,当OrderParamOut为true时返回。

示例

请求示例

https://r-kvstore.aliyuncs.com/?Action=DescribePrice
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-b
&OrderType=BUY
&ChargeType=PostPaid
&Capacity=4096
&<[公共请求参数]>

正常返回示例

XML 格式

<DescribePriceResponse>
      <Order>
            <Currency>CNY</Currency>
            <RuleIds>
        </RuleIds>
            <TradeAmount>0</TradeAmount>
            <OriginalAmount>0</OriginalAmount>
            <Coupons>
        </Coupons>
            <DiscountAmount>0</DiscountAmount>
      </Order>
      <RequestId>3A40BE4E-1890-4972-889C-FEFA37663635</RequestId>
      <SubOrders>
            <SubOrder>
                  <RuleIds>
            </RuleIds>
                  <TradeAmount>0</TradeAmount>
                  <OriginalAmount>0</OriginalAmount>
                  <DiscountAmount>0</DiscountAmount>
            </SubOrder>
      </SubOrders>
      <Rules>
    </Rules>
</DescribePriceResponse>

JSON 格式

{
	"Order": {
		"Currency": "CNY",
		"RuleIds": {
			"RuleId": []
		},
		"TradeAmount": 0,
		"OriginalAmount": 0,
		"Coupons": {
			"Coupon": []
		},
		"DiscountAmount": 0
	},
	"RequestId": "3A40BE4E-1890-4972-889C-FEFA37663635",
	"SubOrders": {
		"SubOrder": [
			{
				"RuleIds": {
					"RuleId": []
				},
				"TradeAmount": 0,
				"OriginalAmount": 0,
				"DiscountAmount": 0
			}
		]
	},
	"Rules": {
		"Rule": []
	}
}

错误码

HttpCode 错误码 错误信息 描述
400 MissingParameter Period is mandatory for this action. 实例Id是必传参数
400 MissingParameter InstanceId is mandatory for this action. 实例名称/密码至少一项是必填的。

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