Use DescribePrice to query instance fees - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Queries the fees for creating, upgrading, or renewing ApsaraDB for Tair (Redis OSS-compatible) instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:DescribePrice

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. You can call the [DescribeRegions](~~473763~~) operation to query the region ID.	cn-hangzhou
Capacity	integer	No	The storage capacity of the instance. Unit: MB. This parameter applies only to Redis Open-Source Edition instances deployed in classic mode. We recommend that you use the InstanceClass parameter to specify an exact instance type. > 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: 1. In the [Instance specifications](~~26350~~) topic, click the link in the References for instance specifications column corresponding to the instance type that you want to view. 2. In the instance type table of the specification documentation, find the instance type in the InstanceClass** column. > 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: purchases instances. * UPGRADE: changes the configurations of instances. * RENEW: renews instances. * CONVERT: changes the billing methods of instances.	BUY
ZoneId	string	No	The zone ID. You can call the [DescribeZones](~~473764~~) operation to query the zone ID.	cn-hangzhou-e
SecondaryZoneId	string	No	The ID of the secondary zone. You can call the [DescribeZones](~~473764~~) operation to query the zone ID. > This value must be different from the ZoneId parameter value.	cn-hangzhou-g
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	integer	No	The subscription duration. Unit: month. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36.	3
Quantity	integer	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. > This parameter is required when the OrderType parameter is set to UPGRADE or RENEW.	r-bp1zxszhcgatnx****
Instances	string	No	Required for querying cloud-native read/write splitting instances, Tair ESSD-based instances, or instances of different specifications. Specify this parameter as a JSON string. For more information, see the Additional description of the Instances parameter section.	[{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","ShardClass": "tair.scm.with.proxy.standard.2m.8d","ShardCount": "3","Period": "1","Quantity": "1"}]
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 order-related parameters. 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 Notes on the Instances Parameter The following notes apply only to the **Instances** parameter of the **DescribePrice** API and do not apply to other APIs.

Name	Type	Required	Example Value	Description
RegionId	String	Yes	cn-hangzhou	The region ID.
InstanceId	String	No	r-7xv4s7q131smyx****	The instance ID. This parameter is required when OrderType is UPGRADE or RENEW.
InstanceClass	String	Yes	redis.master.small.default	The instance type for classic edition instances. For more information, see Instance Type Lookup Guide.
ShardClass	String	Yes	tair.rdb.2g	The instance type for cloud-native edition instances. For more information, see Instance Type Lookup Guide.You must specify either this parameter or InstanceClass.
IzNo	String	No	cn-hangzhou-b	The zone ID.
NodeType	String	No	MASTER_SLAVE	The node type. Valid values: STAND_ALONE: single-replica edition. MASTER_SLAVE (default): high availability (dual-replica).
Period	Long	No	1	The subscription duration in months. Valid values: 1–9, 12, 24, and 36.
Quantity	String	No	1	The number of instances to purchase. Valid values: 1–30. Default value: 1.
VPCId	String	No	vpc-bp1nme44gek34slfc****	The VPC ID.
VSwitchId	String	No	vsw-bp1e7clcw529l773d****	The virtual switch ID.
AutoPay	String	No	true	Specifies whether to enable auto-payment. Valid values: true (default): Yes false: No
InstanceName	String	No	test_123	The instance name.
ShardCount	String	No	2	The number of shard nodes. Default value: 1. You do not need to specify this parameter when querying standard architecture or read/write splitting architecture instances. This parameter applies only to cloud-native edition cluster architecture instances and allows you to customize the number of shards.
ReadOnlyCount	Integer	No	2	The total number of read-only nodes. This parameter applies only to creating cloud-native edition read/write splitting architecture instances.
StorageType	String	No	essd_pl2	The storage class for Tair ESSD disk-based instances. Valid values: essd_pl0, essd_pl1, essd_pl2, and essd_pl3. When you specify this parameter, you must also set Capacity to a custom disk capacity. For more information, see Disk-Based Instance Types.
Capacity	Long	No	512000	The disk capacity for Tair ESSD disk-based instances. Unit: MB.

### Sample Requests Sample request to query the price for purchasing a new Tair cloud-native edition cluster architecture instance (in this scenario, the **Instances** parameter is not required):

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

Sample request to query the price for purchasing a new Tair ESSD disk-based instance with a custom storage class:

{
  "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 to query the price for purchasing a new Tair cloud-native edition read/write splitting architecture 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 to query the price for purchasing 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 to query the renewal price for a Tair cloud-native edition cluster architecture instance (in this scenario, the **Instances** parameter is not required):

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

Response elements

Element	Type	Description	Example
	object
OrderParams	string	The order parameters. Returned only when OrderParamOut is set to `true`.	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	object
Coupon	array<object>	Details about coupons.
	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	object
RuleId	array	The rule IDs.
	string	The rule ID.	[202]
ShowDiscountInfo	boolean	Indicates whether the discount information is displayed.
DepreciateInfo	object	The activity information.
ListPrice	integer	The list price.	1*
OriginalStandAmount	integer	The original total price displayed on the official website.	12*
CheapStandAmount	integer	The new total price displayed on the official website.	9*
CheapRate	integer	The price reduction rate.	30%
Differential	integer	The promotional offer (displayed in the total order amount).	**
DifferentialName	string	The name of the promotional offer.	XXXXX
MonthPrice	integer	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	number	The total discount amount.
FinalFee	number	The preferential price.
ProdFee	number	The original price.	****
ActivityId	integer	The activity ID.	****
OptionCode	string	The promotion code.	****
ActivityName	string	The activity name.	合同优惠_整单_xxx折
OptionIds	object
OptionId	array	The promotion IDs.
	integer	The promotion ID.	*****
StandDiscountPrice	integer	The discount.	****
IsContractActivity	boolean	Indicates whether eligibility for the contracted discount is met.	false
StandPrice	integer	The discounted price.	0
Code	string	The order code.	""
Message	string	The information about the order.	""
Rules	object
Rule	array<object>	Details about promotion rules.
	object
RuleDescId	integer	The ID of the rule.	1111111111
Title	string	The title of the rule.	test
Name	string	The name of the rule.	test
SubOrders	object
SubOrder	array<object>	The orders that match the coupons.
	array<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	object
RuleId	array	The hit rule IDs.
	string	The ID of the hit rule.	RuleId: 1111111111
OptionalPromotions	object
OptionalPromotion	array<object>	The optional promotions.
	array<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	integer	The list price.	****
OriginalStandAmount	integer	The original total price displayed on the official website.	****
CheapStandAmount	integer	The new total price displayed on the official website.	****
CheapRate	integer	The price reduction rate.	****
Differential	integer	The promotional offer (displayed in the total order amount).	****
DifferentialName	string	The name of the promotional offer.	****
MonthPrice	integer	The monthly price.	****
IsContractActivity	boolean	Indicates whether eligibility for the contracted discount is met.	false
ContractActivity	object	The contract promotion.
FinalPromFee	number	The total discount amount.	****
FinalFee	number	The preferential price.	****
ProdFee	number	The original price.	****
ActivityId	integer	The activity ID.	1412025702634847
OptionCode	string	The promotion ID.	****
ActivityName	string	The activity name.	****
OptionIds	object
OptionId	array	The promotion IDs.
	integer	The promotion ID.
StartTime	string	The start time of the activity.	2024-11-18T00:00:00Z
StandDiscountPrice	integer	The discounted price.	****
IsContractActivity	boolean	Indicates whether eligibility for the contracted discount is met.	****
StandPrice	integer	The discounted price.	****
ModuleInstance	object
ModuleInstance	array<object>	The configuration details for each instance of an order line item.
	array<object>	The configuration sub-item of the instance in the order.
ModuleCode	string	The module code.	****
ModuleId	string	The module ID.	****
StandPrice	number	The discounted price.	****
PricingModule	boolean	Indicates whether the item is billed.	****
ModuleName	string	The module name.	****
DiscountFee	number	The discount.	****
TotalProductFee	number	The original price of the instance.	0.0
NeedOrderPay	boolean	Indicates whether the order is paid.	true
PayFee	number	The actual amount paid.	0.0
ModuleAttrs	object
moduleAttr	array<object>	The module attributes.
	object	The module attribute.
Type	integer	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	number	The list price.	****
OriginalStandAmount	number	The original total price displayed on the official website.	****
CheapStandAmount	number	The new total price displayed on the official website.	****
CheapRate	number	The price reduction rate.	******
Differential	number	The promotional offer (displayed in the total order amount).	****
DifferentialName	string	The name of the promotional offer.	****
MonthPrice	number	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	object
PromDetail	array<object>	Details about promotions.
	array<object>	Details about the promotion.
PromotionName	string	The promotion name.	****
PromotionId	integer	The promotion ID.	****
FinalPromFee	number	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

Success response

JSON format

{
  "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": [
        "[202]"
      ]
    },
    "ShowDiscountInfo": false,
    "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": "合同优惠_整单_xxx折",
        "OptionIds": {
          "OptionId": [
            0
          ]
        }
      }
    },
    "StandDiscountPrice": 0,
    "IsContractActivity": true,
    "StandPrice": 0,
    "Code": "\"\"\n",
    "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	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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.