Queries the prices of commodities.
Operation description
You can call the DescribeCommodity operation to query information about the commodity modules.
Debugging
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:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis 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 |
|---|---|---|---|---|
| ga:DescribeCommodityPrice | Read |
|
| 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 | object [] | Yes | The commodity orders. | |
| CommodityCode | string | No | The commodity code. Valid values on the China site (aliyun.com):
Valid values on the international site (alibabacloud.com):
| ga_gapluspre_public_cn |
| OrderType | string | No | The type of the order. Valid values:
| 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 |
| Duration | long | No | The subscription duration.
| 1 |
| Quantity | long | No | The number of instances that you want to purchase. | 1 |
| Components | object [] | No | The information about commodity modules. 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 | object [] | No | The attributes of commodity modules. 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 parameters
Examples
Sample success responses
JSONformat
{
"Currency": "CNY",
"OriginalPrice": 2099,
"DiscountPrice": 419.8,
"TradePrice": 1679.2,
"OrderDetails": [
{
"CommodityCode": "ga_gapluspre_public_cn",
"CommodityName": "Global Accelerator_Instance Type (Subscription)\n",
"OriginalPrice": 2099,
"DiscountPrice": 419.8,
"TradePrice": 1679.2,
"Quantity": 1,
"ModuleDetails": [
{
"ModuleCode": "spec",
"ModuleName": "Specification\n",
"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 Customers Small II Specification Monthly Subscription - 20% Discount\n"
}
],
"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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||
|---|---|---|---|---|---|---|---|---|
| 2023-04-13 | The Error code has changed | see changesets | ||||||
|