All Products
Search
Document Center

Global Accelerator:DescribeCommodityPrice

Last Updated:Jul 31, 2024

Queries the prices of commodities.

Operation description

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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 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.
OperationAccess levelResource typeCondition keyAssociated operation
ga:DescribeCommodityPriceget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.

cn-hangzhou
Ordersarray<object>Yes

The commodity orders.

objectYes

The commodity order.

CommodityCodestringNo

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
OrderTypestringNo

The type of the order. Valid values:

  • BUY: purchase order.
  • RENEW: renewal order.
  • UPGRADE: upgrade order.
BUY
ChargeTypestringNo

The billing method. Set the value to PREPAY, which specifies the subscription billing method.

PREPAY
PricingCyclestringNo

The billing cycle. Valid values:

  • Month
  • Year
Month
DurationlongNo

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
QuantitylongNo

The number of instances that you want to purchase.

1
Componentsarray<object>No

The information about commodity modules.

The information varies based on the commodity module.

objectNo

The information about the commodity module.

The information varies based on the commodity module.

ComponentCodestringNo

The code of the commodity module.

The information varies based on the commodity module. Examples: instance (GA instance) and ord_time (subscription duration).

instance
Propertiesarray<object>No

The attributes of commodity modules.

The information varies based on the commodity module.

objectNo

The attributes of the commodity module.

The information varies based on the commodity module.

CodestringNo

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
ValuestringNo

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
PromotionOptionNostringNo

The coupon code.

Note This parameter is unavailable on the China site (aliyun.com).
50003298014****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Currencystring

The currency unit.

  • China site: CNY.
  • International site: USD.
CNY
OriginalPricedouble

The original price.

2099
DiscountPricedouble

The discount.

419.8
TradePricedouble

The transaction price, which is equal to the original price minus the discount.

1679.2
OrderDetailsarray<object>

The details of the commodity module.

object

The details of the commodity module.

CommodityCodestring

The code of the commodity.

ga_gapluspre_public_cn
CommodityNamestring

The name of the commodity.

Global Accelerator_Instance Type (Subscription)
OriginalPricedouble

The original price.

2099
DiscountPricedouble

The discount.

419.8
TradePricedouble

The transaction price, which is equal to the original price minus the discount.

1679.2
Quantitylong

The number of instances that are purchased.

1
ModuleDetailsarray<object>

The information about the commodity module.

object

The information about the commodity module.

ModuleCodestring

The code of the commodity module.

spec
ModuleNamestring

The name of the commodity module.

Specification
OriginalPricedouble

The original price.

200000.0
DiscountPricedouble

The discount.

40000.0
TradePricedouble

The transaction price, which is equal to the original price minus the discount.

160000.0
RuleIdsarray

The IDs of discount rules.

long

The ID of the discount rule.

102104100786****
PromDetailsarray<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).
PromotionIdstring

The ID of the discount item.

Note This parameter does not take effect for accounts registered on the China site (aliyun.com).
50003298014****
PromotionNamestring

The name of the discount item.

Note This parameter does not take effect for accounts registered on the China site (aliyun.com).
coupon
FinalPromFeedouble

The discounted price.

Note This parameter does not take effect for accounts registered on the China site (aliyun.com).
0.01
PromTypestring

The sub-type of the discount.

Note This parameter does not take effect for accounts registered on the China site (aliyun.com).
deduct
OptionCodestring

The code of the discount option.

Note This parameter does not take effect for accounts registered on the China site (aliyun.com).
youhui_quan
RuleDetailsarray<object>

The details about the discount rules.

object

The details about the discount rule.

RuleIdstring

The ID of the discount rule.

102104100786****
RuleNamestring

The name of the discount rule.

GA New Customers Small II Specification Monthly Subscription - 20% Discount
Promotionsarray<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).
PromotionOptionNostring

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****
    PromotionNamestring

    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
    CanPromFeedouble

    The discounted amount.

    Note This parameter does not take effect for accounts registered on the China site (aliyun.com).
    0
    Selectedboolean

    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
    OptionCodestring

    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
    RequestIdstring

    The ID of the request.

    04F0F334-1335-436C-A1D7-6C044FE73368

    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 codeError codeError messageDescription
    400IllegalParameter.SpecThe specified Spec is invalid.The specified Spec is invalid.
    500UnknownErrorAn 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 timeSummary of changesOperation
    2023-04-13The Error code has changedView Change Details