All Products
Search
Document Center

Global Accelerator:DescribeCommodity

Last Updated:Jul 31, 2024

Queries information about commodities.

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:DescribeCommodityget
  • 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
CommodityCodestringYes

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
OrderTypestringYes

The type of the order. Valid values:

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

Response parameters

ParameterTypeDescriptionExample
object

A list of response parameters.

CommodityCodestring

The commodity code.

Examples for the China site (aliyun.com):

  • ga_gapluspre_public_cn: GA instance.
  • ga_plusbwppre_public_cn: basic bandwidth plan.

Examples for the international site (alibabacloud.com):

  • ga_pluspre_public_intl: GA instance.
  • ga_bwppreintl_public_intl: basic bandwidth plan.
ga_gapluspre_public_cn
CommodityNamestring

The name of the commodity.

Global Accelerator_Instance Type (Subscription)
Componentsarray<object>

The information about the commodity modules.

The returned information varies based on the commodity.

object

The information about the commodity module.

The returned information varies based on the commodity.

ComponentCodestring

The code of the commodity module.

The returned information varies based on the commodity module.

Duration
ComponentNamestring

The name of the commodity module.

The returned information varies based on the commodity module.

Duration
Propertiesarray<object>

The attributes of the commodity module.

The returned information varies based on the commodity module.

object

The attribute of the commodity module.

The returned information varies based on the commodity module.

Codestring

The code of the attribute.

The returned information varies based on the commodity module.

ord_time
Namestring

The name of the attribute.

The returned information varies based on the commodity module.

Duration
PropertyValueListarray<object>

The list of attribute values of the commodity module.

The returned information varies based on the commodity module.

object

The list of attribute values of the commodity module.

The returned information varies based on the commodity module.

Textstring

The content of the attribute.

The returned information varies based on the commodity module.

1 Month
Valuestring

The value of the attribute.

The returned information varies based on the commodity module.

1:Month
Tipsstring

The message of the attribute.

The returned information varies based on the commodity module.

1 Month
OrderIndexlong

The sequence number of the attribute.

The returned information varies based on the commodity module.

1
RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
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