Query commodity information with DescribeCommodity - Global Accelerator - Alibaba Cloud - Global Accelerator

Queries Global Accelerator commodity information by calling the DescribeCommodity operation.

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:DescribeCommodity

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Alibaba Cloud Global Accelerator (GA) instance. Set the value to cn-hangzhou.	cn-hangzhou
CommodityCode	string	Yes	The commodity code. Sample values for Alibaba Cloud China Website (www.aliyun.com): ga_gapluspre_public_cn: Global Accelerator instance. ga_plusbwppre_public_cn: basic bandwidth plan. Sample values for Alibaba Cloud International Website (www.alibabacloud.com): ga_pluspre_public_intl: Global Accelerator instance. ga_bwppreintl_public_intl: basic bandwidth plan.	ga_gapluspre_public_cn
OrderType	string	Yes	The order type. Valid values: BUY: new purchase. RENEW: renewal. UPGRADE: upgrade.	BUY

Response elements

Element	Type	Description	Example
	object	The response parameters.
CommodityCode	string	The commodity code. Sample return values for Alibaba Cloud China Website (www.aliyun.com): ga_gapluspre_public_cn: Global Accelerator instance. ga_plusbwppre_public_cn: basic bandwidth plan. Sample return values for Alibaba Cloud International Website (www.alibabacloud.com): ga_pluspre_public_intl: Global Accelerator instance. ga_bwppreintl_public_intl: basic bandwidth plan.	ga_gapluspre_public_cn
CommodityName	string	The commodity name.	Global Accelerator_Instance Type (Subscription)
Components	array<object>	The commodity component information. The returned content varies depending on the commodity.
	array<object>	The commodity component information. The returned content varies depending on the commodity.
ComponentCode	string	The commodity component code. The returned content varies depending on the commodity component.	Subscription duration
ComponentName	string	The commodity component name. The returned content varies depending on the commodity component.	Subscription duration
Properties	array<object>	The commodity component properties. The returned content varies depending on the commodity component.
	array<object>	The commodity component properties. The returned content varies depending on the commodity component.
Code	string	The commodity component property code. The returned content varies depending on the commodity component.	ord_time
Name	string	The commodity component property name. The returned content varies depending on the commodity component.	Subscription duration
PropertyValueList	array<object>	The list of commodity component property values. The returned content varies depending on the commodity component.
	object	The list of commodity component property values. The returned content varies depending on the commodity component.
Text	string	The commodity component property text. The returned content varies depending on the commodity component.	1 month
Value	string	The commodity component property value. The returned content varies depending on the commodity component.	1:Month
Tips	string	The commodity component property tips. The returned content varies depending on the commodity component.	1 month
OrderIndex	integer	The display order of the commodity component property. The returned content varies depending on the commodity component.	1
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Success response

JSON format

{
  "CommodityCode": "ga_gapluspre_public_cn",
  "CommodityName": "Global Accelerator_Instance Type (Subscription)",
  "Components": [
    {
      "ComponentCode": "Subscription duration",
      "ComponentName": "Subscription duration",
      "Properties": [
        {
          "Code": "ord_time",
          "Name": "Subscription duration",
          "PropertyValueList": [
            {
              "Text": "1 month",
              "Value": "1:Month",
              "Tips": "1 month",
              "OrderIndex": 1
            }
          ]
        }
      ]
    }
  ],
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

HTTP status code	Error code	Error message	Description
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.