DescribePrice - 查询价格_云原生内存数据库Tair-阿里云帮助中心

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域ID，可调用DescribeRegions查询。	cn-hangzhou
Capacity	long	否	使用实例的存储容量指定规格，单位为MB。您需要在InstanceClass和Capacity参数中二选一，用来指定查询的规格。建议您使用InstanceClass参数精确地指定一个规格。	1024
InstanceClass	string	否	使用InstanceClass编码指定实例规格。您需要在InstanceClass和Capacity参数中二选一，用来指定查询的规格。建议您使用InstanceClass参数精确地指定一个规格。 InstanceClass查询步骤：在规格查询导航中，根据需要选择实例类型，点击其架构类型列以打开规格文档。在规格文档的实例规格表中，选择需要的实例规格，并找到其InstanceClass列的编码。云盘集群版规格值参考： Redis 云盘集群版 (redis.cluster.sharding.common.ce)。 Tair 内存型云盘集群版 (tair.rdb.cluster.sharding.common)。 Tair 持久内存型云盘集群版 (tair.scm.cluster.sharding.common.ce)。	redis.master.small.default
OrderType	string	是	订单类型，取值： BUY：新购。 UPGRADE：变更配置。 RENEW：续费。 CONVERT：转换付费类型。	BUY
ZoneId	string	否	可用区ID，可调用DescribeZones查询。	cn-hangzhou-e
ChargeType	string	否	付费类型，取值： PostPaid（默认）：按量付费。 PrePaid：包年包月。	PostPaid
NodeType	string	否	节点类型，取值： STAND_ALONE：单副本。 MASTER_SLAVE（默认）：高可用（双副本）。	MASTER_SLAVE
Period	long	否	包年包月时长，单位为月。取值范围：1~9、12、24、36。	3
Quantity	long	否	购买实例的数量，取值范围：1~30，默认值为1。	1
InstanceId	string	否	实例ID。说明当OrderType为UPGRADE或RENEW时必传。	r-bp1zxszhcgatnx****
Instances	string	否	包含查询云盘架构实例或多个实例的JSON格式字符串，更多信息请参见Instances参数补充说明。	Instances=[{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","InstanceClass": "redis.master.small.default","Period": "1","Quantity": "1","Capacity": "4096"}]
BusinessInfo	string	否	活动ID、业务信息等扩展信息。	000000000000
CouponNo	string	否	优惠码，默认值：youhuiquan_promotion_option_id_for_blank，表示无优惠码。	youhuiquan_promotion_option_id_for_blank
ForceUpgrade	boolean	否	是否强制变配，取值： false：是。 true（默认）：否。	true
OrderParamOut	string	否	是否返回订单参数，可选值： false（默认）：不返回。 true：返回。	true

Instances参数补充说明

以下说明仅适用于DescribePrice接口Instances参数的补充说明，不适用于其它接口。

名称	类型	是否必选	示例值	描述
InstanceId	String	否	r-7xv4s7q131smyx****	实例ID，当OrderType为UPGRADE或RENEW时必传。
Capacity	Long	是	16384	实例的存储容量，单位：MB。说明：本参数和InstanceClass两者中必须传入一项。
InstanceClass	String	是	redis.master.small.default	实例规格，请参见规格查询导航。
IzNo	String	是	cn-hangzhou-b	可用区ID。
NodeType	String	否	MASTER_SLAVE	节点类型，取值： STAND_ALONE：单副本。 MASTER_SLAVE（默认）：高可用（双副本）。
Period	Long	否	1	包年包月时长，单位为月。取值范围：1~9、12、24、36。
Quantity	String	否	1	购买实例的数量，取值范围：1~30。默认值：1。
VPCId	String	否	vpc-bp1nme44gek34slfc****	VPC ID。
VSwitchId	String	否	vsw-bp1e7clcw529l773d****	虚拟交换机ID。
AutoPay	String	否	true	是否自动付款，取值： true（默认）：是 false：否
InstanceName	String	否	test_123	实例名称。
ShardClass	String	否	tair.rdb.2g	分片规格，本参数仅适用于创建云盘版集群架构实例。
ShardCount	String	否	2	分片数，本参数仅适用于创建云盘版集群架构实例，您可以通过该参数实现自定义分片数量。

Instances参数请求示例

查询Tair云盘版集群架构的请求示例：

{
  "RegionId": "cn-hangzhou",
  "OrderType": "BUY",
  "InstanceClass": "tair.rdb.cluster.sharding.common",
  "ChargeType": "PostPaid",
  "Instances": "[{\"RegionId\": \"cn-hangzhou\",\"ZoneId\": \"cn-hangzhou-h\", \"ShardClass\": \"tair.rdb.2g\", \"ShardCount\": \"3\", \"Period\": \"1\",\"Quantity\": \"1\"}]",
  "ZoneId": "cn-hangzhou-h",
  "SourceIp": "192.168.0.1"
}

查询多个实例的请求示例：

{
  "RegionId": "cn-hangzhou",
  "OrderType": "BUY",
  "InstanceClass": "tair.rdb.cluster.sharding.common",
  "ChargeType": "PostPaid",
  "Instances": "[{\"RegionId\": \"cn-hangzhou\",\"ZoneId\": \"cn-hangzhou-h\", \"ShardClass\": \"tair.rdb.2g\", \"ShardCount\": \"3\", \"Period\": \"1\",\"Quantity\": \"1\"}{\"RegionId\": \"cn-hangzhou\",\"ZoneId\": \"cn-hangzhou-h\", \"ShardClass\": \"tair.rdb.with.proxy.2g\", \"ShardCount\": \"3\", \"Period\": \"1\",\"Quantity\": \"1\"}]",
  "ZoneId": "cn-hangzhou-h",
  "SourceIp": "192.168.0.1"
}

返回参数

名称	类型	描述	示例值
	object
OrderParams	string	订单参数，当OrderParamOut为`true`时返回。	String
RequestId	string	请求ID。	3A40BE4E-1890-4972-889C-FEFA37663635
Order	object	订单信息。
OriginalAmount	string	订单原价。	0.21
HandlingFeeAmount	string	手续费。	0.1
Currency	string	币种，中国站为CNY（人民币）；国际站为USD（美元）。	CNY
DiscountAmount	string	订单优惠金额。	0.21
TradeAmount	string	订单实际交易价。	10
Coupons	object []	优惠券信息。
IsSelected	string	是否选中该优惠券。	true
CouponNo	string	优惠券编码。	youhuiquan_promotion_option_id_for_blank
Name	string	优惠券名称。	test
Description	string	优惠券描述。	coupondemo
RuleIds	array	活动ID。
	string	活动ID。	1001199213
Rules	object []	活动规格。
RuleDescId	long	策略ID。	1111111111
Title	string	策略标题。	test
Name	string	活动名称。	test
SubOrders	object []	优惠券对应的策略。
OriginalAmount	string	订单原价。	0.21
InstanceId	string	实例ID。	r-bp1xxxxxxxxxxxxx
DiscountAmount	string	订单优惠金额。	0.21
TradeAmount	string	订单实际交易价。	10
RuleIds	array	活动ID。
	string	命中策略的ID。	RuleId: 1111111111

示例

正常返回示例

JSON格式

{
  "OrderParams": "String",
  "RequestId": "3A40BE4E-1890-4972-889C-FEFA37663635",
  "Order": {
    "OriginalAmount": "0.21",
    "HandlingFeeAmount": "0.1",
    "Currency": "CNY",
    "DiscountAmount": "0.21",
    "TradeAmount": "10",
    "Coupons": {
      "Coupon": [
        {
          "IsSelected": "true",
          "CouponNo": "youhuiquan_promotion_option_id_for_blank",
          "Name": "test",
          "Description": "coupondemo"
        }
      ]
    },
    "RuleIds": {
      "RuleId": [
        "1001199213"
      ]
    }
  },
  "Rules": {
    "Rule": [
      {
        "RuleDescId": 1111111111,
        "Title": "test",
        "Name": "test"
      }
    ]
  },
  "SubOrders": {
    "SubOrder": [
      {
        "OriginalAmount": "0.21",
        "InstanceId": "r-bp1xxxxxxxxxxxxx",
        "DiscountAmount": "0.21",
        "TradeAmount": "10",
        "RuleIds": {
          "RuleId": [
            "RuleId: 1111111111"
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息
400	MissingParameter	Period is mandatory for this action.
400	MissingParameter	InstanceId is mandatory for this action.
400	InvalidInstances.Format	The Specified parameter Instances is not valid.
400	AlreadyHadTemporaryBandwidth	This instance have already had temporary bandwidth, please modify instance spec first.

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