DescribePrice - Tair (Redis® OSS-Compatible) - Alibaba Cloud Documentation Center

Queries the fees that you must pay when you create, upgrade, or renew a Tair (Redis OSS-compatible) instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
kvstore:DescribePrice	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
Capacity	long	No	The storage capacity of the instance. Unit: MB. This parameter is used only to query Redis Open-Source Edition instances that are deployed in classic mode. We recommend that you use the InstanceClass parameter to specify an exact instance type. Note If you specify the InstanceClass parameter, you do not need to specify the Capacity parameter.	1024
InstanceClass	string	No	The instance type.** To view the instance type, perform the following steps: In the Instance specifications topic, click the link in the References for instance specifications column corresponding to the instance type that you want to view. In the instance type table of the specification documentation, find the instance type in the InstanceClass column. Note If you want to query new instances, in addition to key parameters, you must also specify at least the following parameters: To query a classic instance, specify this parameter. To query a cloud-native standard instance, specify this parameter. To query a cloud-native cluster instance, specify this parameter and the ShardCount parameter. To query a cloud-native read/write splitting instance, specify this parameter and the Instances** parameter. To query multiple instances of different specifications or to query a Tair ESSD-based instance that has a custom storage type and storage capacity, specify the Instances parameter. In this case, you do not need to specify the InstanceClass parameter.	redis.master.small.default
OrderType	string	Yes	The order type. Valid values: BUY: specifies the orders that are used to purchase instances. UPGRADE: specifies the orders that are used to change the configurations of instances. RENEW: specifies the orders that are used to renew instances. CONVERT: specifies the orders that are used to change the billing methods of instances.	BUY
ZoneId	string	No	The zone ID. You can call the DescribeZones operation to query the zone ID.	cn-hangzhou-e
ChargeType	string	No	The billing method. Valid values: PostPaid (default): pay-as-you-go PrePaid: subscription	PostPaid
NodeType	string	No	The node type. Valid values: STAND_ALONE: standalone MASTER_SLAVE (default): high availability (master-replica)	MASTER_SLAVE
Period	long	No	The subscription duration. Unit: month. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36.	3
Quantity	long	No	The number of instances that you want to purchase. Valid values: 1 to 30. Default value: 1.	1
InstanceId	string	No	The instance ID. Note This parameter is required when the OrderType parameter is set to UPGRADE or RENEW.	r-bp1zxszhcgatnx****
Instances	string	No	If you want to query cloud-native read/write splitting instances, Tair ESSD-based instances, or instances of different specifications, you must specify this parameter as a JSON string. For more information, see the Additional description of the Instances parameter section.	Instances=[{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","InstanceClass": "redis.master.small.default","Period": "1","Quantity": "1","Capacity": "4096"}]
BusinessInfo	string	No	The extended information such as the promotional event ID and business information.	000000000000
CouponNo	string	No	The coupon code. Default value: youhuiquan_promotion_option_id_for_blank. This value indicates that no coupon code is available.	youhuiquan_promotion_option_id_for_blank
ForceUpgrade	boolean	No	Specifies whether to forcefully change the configurations of the instance. Valid values: false: forcefully changes the configurations. true (default): does not forcefully change the configurations.	true
OrderParamOut	string	No	Specifies whether to return parameters related to the order. Valid values: false (default) true	true
ShardCount	integer	No	The number of data shards in the cloud-native cluster instance.	2
EngineVersion	string	No	The engine version of the instance. Valid values: 2.8, 4.0, and 5.0.	5.0

Additional description of the Instances parameter

The following description applies only to the Instances parameter of the DescribePrice operation.

Parameter	Type	Required	Example	Description
RegionId	String	Yes	cn-hangzhou	The region ID.
InstanceId	String	No	r-7xv4s7q131smyx****	The instance ID. This parameter is required if the OrderType parameter is set to UPGRADE or RENEW.
InstanceClass	String	Yes	redis.master.small.default	The instance type of the classic instance. For more information, see Instance specifications.
ShardClass	String	Yes	tair.rdb.2g	The instance type of the cloud-native instance. For more information, see Instance specifications.You must specify this parameter or the InstanceClass parameter.
IzNo	String	No	cn-hangzhou-b	The zone ID.
NodeType	String	No	MASTER_SLAVE	The node type. Valid values: STAND_ALONE: standalone MASTER_SLAVE (default): high availability (master-replica)
Period	Long	No	1	The subscription duration. Unit: month. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36.
Quantity	String	No	1	The number of instances that you want to purchase. Valid values: 1 to 30. Default value: 1.
VPCId	String	No	vpc-bp1nme44gek34slfc****	The virtual private cloud (VPC) ID.
VSwitchId	String	No	vsw-bp1e7clcw529l773d****	The vSwitch ID.
AutoPay	String	No	true	Specifies whether to enable automatic payment. Valid values: true (default) false
InstanceName	String	No	test_123	The instance name.
ShardCount	String	No	2	The number of shards. Default value: 1. You do not need to specify this parameter when you query standard or read/write splitting instances. This parameter applies only to cloud-native cluster instances.
ReadOnlyCount	Integer	No	2	The total number of read replicas. This parameter applies only to cloud-native read/write splitting instances.
StorageType	String	No	essd_pl2	The storage type of the Tair ESSD-based instance. Valid values: essd_pl0, essd_pl1, essd_pl2, and essd_pl3. When you specify this parameter, you must also specify the Capacity parameter. For more information, see Specifications of ESSD/SSD-based instances.
Capacity	Long	No	512000	The disk capacity of the Tair ESSD-based instance. Unit: MB.

Sample requests

Sample request for querying a Tair cloud-native cluster instance (Instances not required in this scenario):

{
  "RegionId": "cn-hangzhou",
  "InstanceClass": "tair.rdb.with.proxy.2g",
  "OrderType": "BUY",
  "ChargeType": "PrePaid",
  "Period": 1,
  "ShardCount": 3
}

Sample request for querying a Tair ESSD-based instance of a specific storage type:

{
  "RegionId": "cn-hangzhou",
  "OrderType": "BUY",
  "ChargeType": "PostPaid",
  "Instances": "[{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-h", "ShardClass": "tair.essd.standard.2xlarge", "ShardCount": "1","Capacity": "512000","StorageType": "essd_pl2"}]",
}

Sample request for querying a Tair cloud-native read/write splitting instance:

{
  "RegionId": "cn-hangzhou",
  "InstanceClass": "tair.rdb.with.proxy.2g",
  "OrderType": "BUY",
  "ChargeType": "PrePaid",
  "Period": 1,
  "Instances": "[{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","ShardClass":"tair.rdb.with.proxy.2g","ReadOnlyCount":"2"}]"
}

Sample request for querying multiple instances:

{
  "RegionId": "cn-hangzhou",
  "OrderType": "BUY",
  "ChargeType": "PrePaid",
  "Period": 1,
  "Instances": "[{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","InstanceClass": "redis.master.small.default"}{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","InstanceClass": "redis.amber.logic.sharding.1g.2db.0rodb.6proxy.multithread"}{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","ShardClass":"tair.rdb.with.proxy.2g","ShardCount":"3"}]"
}

Sample request for renewing a Tair cloud-native cluster instance (Instances not required in this scenario):

{
  "RegionId": "cn-hangzhou",
  "InstanceClass": "tair.rdb.with.proxy.1g",
  "OrderType": "RENEW",
  "ChargeType": "PrePaid",
  "Period": 12,
  "InstanceId": "r-d7****l3v0xmorw1xp",
  "ShardCount": 3
}

Response parameters

Parameter	Type	Description	Example
	object
OrderParams	string	The parameters of the order. When OrderParamOut is set to `true`, this parameter is returned.	String
RequestId	string	The request ID.	3A40BE4E-1890-4972-889C-FEFA37663635
Order	object	The information about the order.
OriginalAmount	string	The original price of the order.	0.21
HandlingFeeAmount	string	The service fees of the order.	0.1
Currency	string	The currency used for payment. A value of CNY is used when the order was generated on the China site (aliyun.com), and a value of USD is used when the order was generated on the international site (alibabacloud.com).	CNY
DiscountAmount	string	The discount amount of the order.	0.21
TradeAmount	string	The transaction price of the order.	10
Coupons	array<object>	Details about coupons.
Coupon	object	Details about the coupon.
IsSelected	string	Indicates whether the coupon is selected.	true
CouponNo	string	The coupon ID.	youhuiquan_promotion_option_id_for_blank
Name	string	The coupon name.	test
Description	string	The coupon description.	coupondemo
RuleIds	array	The rule IDs.
RuleId	string	The rule ID.	1001199213
ShowDiscountInfo	boolean	Indicates whether the discount information is displayed.
DepreciateInfo	object	The activity information.
ListPrice	long	The list price.	1*
OriginalStandAmount	long	The original total price displayed on the official website.	12*
CheapStandAmount	long	The new total price displayed on the official website.	9*
CheapRate	long	The price reduction rate.	30%
Differential	long	The promotional offer (displayed in the total order amount).	**
DifferentialName	string	The name of the promotional offer.	XXXXX
MonthPrice	long	The monthly price.	**
IsContractActivity	boolean	Indicates whether eligibility for the contracted discount is met.	false
IsShow	boolean	Indicates whether the price reduction rate is displayed.	true
ContractActivity	object	The activity information.
FinalPromFee	double	The total discount amount.
FinalFee	double	The preferential price.
ProdFee	double	The original price.	****
ActivityId	long	The activity ID.	****
OptionCode	string	The promotion code.	****
ActivityName	string	The activity name.	contract promotion_order_xxx discount
OptionIds	array	The promotion IDs.
OptionId	long	The promotion ID.	*****
StandDiscountPrice	long	The discount.	****
IsContractActivity	boolean	Indicates whether eligibility for the contracted discount is met.	false
StandPrice	long	The discounted price.	0
Code	string	The order code.	""
Message	string	The information about the order.	""
Rules	array<object>	Details about promotion rules.
Rule	object
RuleDescId	long	The ID of the rule.	1111111111
Title	string	The title of the rule.	test
Name	string	The name of the rule.	test
SubOrders	array<object>	The orders that match the coupons.
SubOrder	object
OriginalAmount	string	The original price of the order.	0.21
InstanceId	string	The instance ID.	r-bp1xxxxxxxxxxxxx
DiscountAmount	string	The discount amount of the order.	0.21
TradeAmount	string	The transaction price of the order.	10
RuleIds	array	The hit rule IDs.
RuleId	string	The ID of the hit rule.	RuleId: 1111111111
OptionalPromotions	array<object>	The optional promotions.
OptionalPromotion	object
Selected	boolean	Indicates whether the promotion option is selected.	false
CouponNo	string	Indicates whether coupons are used. Valid values: default or null (default): Coupons are used. youhuiquan_promotion_option_id_for_blank: Coupons are not used.	default
Name	string	The coupon name.	****
Description	string	The description of the coupon.	****
Show	boolean	Indicates whether the discount is displayed.	False
ActivityExtInfo	object	The additional activity information.	****
OptionCode	string	The promotion code.	****
PromotionName	string	The promotion name.	****
PromotionOptionNo	string	The promotion ID.	youhuiquan_promotion_option_id_for_blank
CanPromFee	string	The amount that can be deducted by using the coupon.	****
DepreciateInfo	object	The price reduction information.
ListPrice	long	The list price.	****
OriginalStandAmount	long	The original total price displayed on the official website.	****
CheapStandAmount	long	The new total price displayed on the official website.	****
CheapRate	long	The price reduction rate.	****
Differential	long	The promotional offer (displayed in the total order amount).	****
DifferentialName	string	The name of the promotional offer.	****
MonthPrice	long	The monthly price.	****
IsContractActivity	boolean	Indicates whether eligibility for the contracted discount is met.	false
ContractActivity	object	The contract promotion.
FinalPromFee	double	The total discount amount.	****
FinalFee	double	The preferential price.	****
ProdFee	double	The original price.	****
ActivityId	long	The activity ID.	1412025702634847
OptionCode	string	The promotion ID.	****
ActivityName	string	The activity name.	****
OptionIds	array	The promotion IDs.
OptionId	long	The promotion ID.
StartTime	string	The start time of the activity.	2024-11-18T00:00:00Z
StandDiscountPrice	long	The discounted price.	****
IsContractActivity	boolean	Indicates whether eligibility for the contracted discount is met.	****
StandPrice	long	The discounted price.	****
ModuleInstance	array<object>	The configuration details for each instance of an order line item.
ModuleInstance	object	The configuration sub-item of the instance in the order.
ModuleCode	string	The module code.	****
ModuleId	string	The module ID.	****
StandPrice	double	The discounted price.	****
PricingModule	boolean	Indicates whether the item is billed.	****
ModuleName	string	The module name.	****
DiscountFee	double	The discount.	****
TotalProductFee	double	The original price of the instance.	0.0
NeedOrderPay	boolean	Indicates whether the order is paid.	true
PayFee	double	The actual amount paid.	0.0
ModuleAttrs	array<object>	The module attributes.
moduleAttr	object	The module attribute.
Type	long	The attribute type.	****
Value	string	The attribute value.	****
Code	string	The attribute code.	****
Name	string	The attribute name.	****
ContractActivity	boolean	Indicates whether eligibility for the contracted discount is met.	****
DepreciateInfo	object	The price reduction information.
ListPrice	double	The list price.	****
OriginalStandAmount	double	The original total price displayed on the official website.	****
CheapStandAmount	double	The new total price displayed on the official website.	****
CheapRate	double	The price reduction rate.	******
Differential	double	The promotional offer (displayed in the total order amount).	****
DifferentialName	string	The name of the promotional offer.	****
MonthPrice	double	The monthly price.	****
IsContractActivity	boolean	Indicates whether eligibility for the contracted discount is met.	****
IsShow	boolean	Indicates whether the price reduction rate is displayed.	true
StartTime	string	The start time of the activity.	2024-09-23T14:00:01Z
PromDetailList	array<object>	Details about promotions.
PromDetail	object	Details about the promotion.
PromotionName	string	The promotion name.	****
PromotionId	long	The promotion ID.	****
FinalPromFee	double	The discount amount.	****
OptionCode	string	The coupon code.	****
PromType	string	The promotion type.	****
ActivityExtInfo	object	The additional activity information.	****
DerivedPromType	string	The derived promotion type.	****
PromotionCode	string	The promotion code.	****
ContractActivity	boolean	Indicates whether eligibility for the contracted discount is met.	****

Examples

Sample success responses

JSONformat

{
  "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
      ]
    },
    "ShowDiscountInfo": true,
    "DepreciateInfo": {
      "ListPrice": 0,
      "OriginalStandAmount": 0,
      "CheapStandAmount": 0,
      "CheapRate": 0,
      "Differential": 0,
      "DifferentialName": "XXXXX",
      "MonthPrice": 0,
      "IsContractActivity": false,
      "IsShow": true,
      "ContractActivity": {
        "FinalPromFee": 0,
        "FinalFee": 0,
        "ProdFee": 0,
        "ActivityId": 0,
        "OptionCode": "****",
        "ActivityName": "contract promotion_order_xxx discount\n",
        "OptionIds": {
          "OptionId": [
            0
          ]
        }
      }
    },
    "StandDiscountPrice": 0,
    "IsContractActivity": true,
    "StandPrice": 0,
    "Code": "",
    "Message": ""
  },
  "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"
          ]
        },
        "OptionalPromotions": {
          "OptionalPromotion": [
            {
              "Selected": false,
              "CouponNo": "default",
              "Name": "****",
              "Description": "****",
              "Show": true,
              "ActivityExtInfo": {
                "test": "test",
                "test2": 1
              },
              "OptionCode": "****",
              "PromotionName": "****",
              "PromotionOptionNo": "youhuiquan_promotion_option_id_for_blank",
              "CanPromFee": "****"
            }
          ]
        },
        "DepreciateInfo": {
          "ListPrice": 0,
          "OriginalStandAmount": 0,
          "CheapStandAmount": 0,
          "CheapRate": 0,
          "Differential": 0,
          "DifferentialName": "****",
          "MonthPrice": 0,
          "IsContractActivity": false,
          "ContractActivity": {
            "FinalPromFee": 0,
            "FinalFee": 0,
            "ProdFee": 0,
            "ActivityId": 1412025702634847,
            "OptionCode": "****",
            "ActivityName": "****",
            "OptionIds": {
              "OptionId": [
                0
              ]
            }
          },
          "StartTime": "2024-11-18T00:00:00Z"
        },
        "StandDiscountPrice": 0,
        "IsContractActivity": true,
        "StandPrice": 0,
        "ModuleInstance": {
          "ModuleInstance": [
            {
              "ModuleCode": "****",
              "ModuleId": "****",
              "StandPrice": 0,
              "PricingModule": true,
              "ModuleName": "****",
              "DiscountFee": 0,
              "TotalProductFee": 0,
              "NeedOrderPay": true,
              "PayFee": 0,
              "ModuleAttrs": {
                "moduleAttr": [
                  {
                    "Type": 0,
                    "Value": "****",
                    "Code": "****",
                    "Name": "****"
                  }
                ]
              },
              "ContractActivity": true,
              "DepreciateInfo": {
                "ListPrice": 0,
                "OriginalStandAmount": 0,
                "CheapStandAmount": 0,
                "CheapRate": 0,
                "Differential": 0,
                "DifferentialName": "****",
                "MonthPrice": 0,
                "IsContractActivity": true,
                "IsShow": true,
                "StartTime": "2024-09-23T14:00:01Z"
              }
            }
          ]
        },
        "PromDetailList": {
          "PromDetail": [
            {
              "PromotionName": "****",
              "PromotionId": 0,
              "FinalPromFee": 0,
              "OptionCode": "****",
              "PromType": "****",
              "ActivityExtInfo": {
                "test": "test",
                "test2": 1
              },
              "DerivedPromType": "****",
              "PromotionCode": "****"
            }
          ]
        },
        "ContractActivity": true
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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.	The Instances parameter passed in is invalid
400	AlreadyHadTemporaryBandwidth	This instance have already had temporary bandwidth, please modify instance spec first.	-

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

Change history

Change time	Summary of changes	Operation
2025-03-25	API Description Update. The Error code has changed	View Change Details
2025-02-10	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-07-31	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-04-10	The Error code has changed. The response structure of the API has changed	View Change Details
2024-04-07	The Error code has changed. The response structure of the API has changed	View Change Details
2024-03-26	The Error code has changed. The response structure of the API has changed	View Change Details
2024-02-28	The Error code has changed. The response structure of the API has changed	View Change Details
2023-09-18	The Error code has changed. The response structure of the API has changed	View Change Details