Use DescribeCommodityPrice to query commodity prices - Global Accelerator - Alibaba Cloud - Global Accelerator

Queries the prices of commodities.

Operation description

You can call the DescribeCommodity operation to query information about the commodity modules.

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

ga:DescribeCommodityPrice

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.	cn-hangzhou
Orders	array<object>	Yes	The commodity orders.
	array<object>	No	The commodity order.
CommodityCode	string	No	The commodity code. Valid values on the China site (aliyun.com): ga_gapluspre_public_cn: GA instance. ga_plusbwppre_public_cn: basic bandwidth plan. Valid values on the international site (alibabacloud.com): ga_pluspre_public_intl: GA instance. ga_bwppreintl_public_intl: basic bandwidth plan.	ga_gapluspre_public_cn
OrderType	string	No	The type of the order. Valid values: BUY: purchase order. RENEW: renewal order. UPGRADE: upgrade order.	BUY
ChargeType	string	No	The billing method. Set the value to PREPAY, which specifies the subscription billing method.	PREPAY
PricingCycle	string	No	The billing cycle. Valid values: Month Year	Month
Duration	integer	No	The subscription duration. Valid values if you set PricingCycle to Month: 1 to 9. Valid values if you set PricingCycle to Year: 1 to 3.	1
Quantity	integer	No	The number of instances that you want to purchase.	1
Components	array<object>	No	The information about commodity modules. The information varies based on the commodity module.
	array<object>	No	The information about the commodity module. The information varies based on the commodity module.
ComponentCode	string	No	The code of the commodity module. The information varies based on the commodity module. Examples: instance (GA instance) and ord_time (subscription duration).	instance
Properties	array<object>	No	The attributes of commodity modules. The information varies based on the commodity module.
	object	No	The attributes of the commodity module. The information varies based on the commodity module.
Code	string	No	The code of the attribute of the commodity module. The information varies based on the commodity module. Examples: instance (GA instance) and ord_time (subscription duration).	instance
Value	string	No	The value of the attribute. The information varies based on the commodity module. Examples: instance_fee (GA instance fee) and 1:Month (one-month subscription).	instance_fee
PromotionOptionNo	string	No	The coupon code. Note This parameter is unavailable on the China site (aliyun.com).	50003298014****

Response elements

Element	Type	Description	Example
	object	The response parameters.
Currency	string	The currency unit. China site: CNY. International site: USD.	CNY
OriginalPrice	number	The original price.	2099
DiscountPrice	number	The discount.	419.8
TradePrice	number	The transaction price, which is equal to the original price minus the discount.	1679.2
OrderDetails	array<object>	The details of the commodity module.
	array<object>	The details of the commodity module.
CommodityCode	string	The code of the commodity.	ga_gapluspre_public_cn
CommodityName	string	The name of the commodity.	Global Accelerator_Instance Type (Subscription)
OriginalPrice	number	The original price.	2099
DiscountPrice	number	The discount.	419.8
TradePrice	number	The transaction price, which is equal to the original price minus the discount.	1679.2
Quantity	integer	The number of instances that are purchased.	1
ModuleDetails	array<object>	The information about the commodity module.
	object	The information about the commodity module.
ModuleCode	string	The code of the commodity module.	spec
ModuleName	string	The name of the commodity module.	Specification
OriginalPrice	number	The original price.	200000.0
DiscountPrice	number	The discount.	40000.0
TradePrice	number	The transaction price, which is equal to the original price minus the discount.	160000.0
RuleIds	array	The IDs of discount rules.
	integer	The ID of the discount rule.	102104100786****
PromDetails	array<object>	The details of the discount. Note This parameter does not take effect for accounts registered on the China site (aliyun.com).
	object	The details about the discount. Note This parameter is unavailable on the China site (aliyun.com).
PromotionId	string	The ID of the discount item. Note This parameter does not take effect for accounts registered on the China site (aliyun.com).	50003298014****
PromotionName	string	The name of the discount item. Note This parameter does not take effect for accounts registered on the China site (aliyun.com).	coupon
FinalPromFee	number	The discounted price. Note This parameter does not take effect for accounts registered on the China site (aliyun.com).	0.01
PromType	string	The sub-type of the discount. Note This parameter does not take effect for accounts registered on the China site (aliyun.com).	deduct
OptionCode	string	The code of the discount option. Note This parameter does not take effect for accounts registered on the China site (aliyun.com).	youhui_quan
RuleDetails	array<object>	The details about the discount rules.
	object	The details about the discount rule.
RuleId	string	The ID of the discount rule.	102104100786****
RuleName	string	The name of the discount rule.	GA New Customers Small II Specification Monthly Subscription - 20% Discount
Promotions	array<object>	The details of the coupon. Note This parameter does not take effect for accounts registered on the China site (aliyun.com).
	object	The list of coupons. Note This parameter is unavailable on the China site (aliyun.com).
PromotionOptionNo	string	The code of the coupon. Note `youhuiquan_promotion_option_id_for_blank` indicates coupons that cannot be applied to the commodity. This parameter does not take effect for accounts registered on the China site (aliyun.com).	50003298014****
PromotionName	string	The name of the coupon. Note This parameter does not take effect for accounts registered on the China site (aliyun.com).	youhuiquan_promotion_option_id_for_blank
CanPromFee	number	The discounted amount. Note This parameter does not take effect for accounts registered on the China site (aliyun.com).	0
Selected	boolean	Indicates whether the coupon was selected. true false Note This parameter does not take effect for accounts registered on the China site (aliyun.com).	false
OptionCode	string	The code of the commodity to which the coupon can be applied. Note This parameter does not take effect for accounts registered on the China site (aliyun.com).	youhui_quan
RequestId	string	The ID of the request.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Success response

JSON format

{
  "Currency": "CNY",
  "OriginalPrice": 2099,
  "DiscountPrice": 419.8,
  "TradePrice": 1679.2,
  "OrderDetails": [
    {
      "CommodityCode": "ga_gapluspre_public_cn",
      "CommodityName": "Global Accelerator_Instance Specification (Subscription)",
      "OriginalPrice": 2099,
      "DiscountPrice": 419.8,
      "TradePrice": 1679.2,
      "Quantity": 1,
      "ModuleDetails": [
        {
          "ModuleCode": "spec",
          "ModuleName": "Specification",
          "OriginalPrice": 200000,
          "DiscountPrice": 40000,
          "TradePrice": 160000
        }
      ],
      "RuleIds": [
        0
      ],
      "PromDetails": [
        {
          "PromotionId": "50003298014****",
          "PromotionName": "coupon",
          "FinalPromFee": 0.01,
          "PromType": "deduct",
          "OptionCode": "youhui_quan"
        }
      ]
    }
  ],
  "RuleDetails": [
    {
      "RuleId": "102104100786****",
      "RuleName": "GA New Customer Small II Specification Monthly - 20% Off"
    }
  ],
  "Promotions": [
    {
      "PromotionOptionNo": "50003298014****",
      "PromotionName": "youhuiquan_promotion_option_id_for_blank",
      "CanPromFee": 0,
      "Selected": false,
      "OptionCode": "youhui_quan"
    }
  ],
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParameter.Spec	The specified Spec is invalid.	The specified Spec is invalid.
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	An error occurred while the request was being processed. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.