QueryCommodityList-阿里云帮助中心

Queries a list of commodity information by product code.

Operation description

This API operation queries a list of commodity information based on a product code.

Try it now

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

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

bss:DescribeProduct

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProductCode	string	Yes	The product code.	ecs
Lang	string	No	The language. If you do not specify this parameter, the default value `zh` (Chinese) is used.	en

Response elements

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	CC706AAC-75A6-55B5-9AB7-7D171C6C7655
Message	string	Additional information about the call result.	Successful!
Success	boolean	Indicates whether the call was successful.	True
Code	string	The status code.	NotApplicable
Data	object	The returned data.
CommodityList	array<object>	The list of commodities.
	object	The list of commodities.
CommodityCode	string	The commodity code. This code is the same as the product code in the User Center.	ecs
CommodityName	string	The name of the commodity.	ECS (Pay-As-You-Go)
ChargeType	string	The billing method. Valid values: - POSTPAY: pay-as-you-go. - PREPAY: subscription.	POSTPAY

Examples

Success response

JSON format

{
  "RequestId": "CC706AAC-75A6-55B5-9AB7-7D171C6C7655",
  "Message": "Successful!",
  "Success": true,
  "Code": "NotApplicable",
  "Data": {
    "CommodityList": [
      {
        "CommodityCode": "ecs",
        "CommodityName": "ECS (Pay-As-You-Go)\n",
        "ChargeType": "POSTPAY"
      }
    ]
  }
}

Error codes

See for a complete list.

Release notes

See 变更详情 for a complete list.