QueryPriceEntityList - Expenses and Costs - Alibaba Cloud Documentation Center

Queries the pricing objects of a product. A pricing object is the smallest unit of a product's capability used for metering and billing.

Operation description

Use this API to query the pricing objects of a product. A pricing object is the smallest unit of a product's capability used for metering and billing.

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

bss:DescribeProduct

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CommodityCode	string	Yes	The code of the product. To find the product code, call the QueryCommodityList operation.	ecs
Lang	string	No	The language. The default value is zh (Chinese).	en

Response elements

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	79EE7556-0CFD-44EB-9CD6-B3B526E3A85F
Code	string	The status code.	Success
Message	string	The response message.	Successful！
Success	boolean	Indicates whether the request was successful.	true
Data	object	The returned data.
PriceEntityInfoList	array<object>	The list of pricing objects.
	object	A pricing object.
PriceEntityCode	string	The code of the pricing object.	instance_type
PriceEntityName	string	The name of the pricing object.	Elastic Compute Service (ECS) instance
PriceFactorList	array<object>	The list of pricing factors.
	object	A pricing factor.
PriceFactorCode	string	The code of the pricing factor.	vm_region_no
PriceFactorName	string	The name of the pricing factor.	Region
PriceFactorValueList	array	The list of pricing factor values.
	string	The value of the pricing factor.	cn-shiwei-shenshu

A product has one or more pricing objects. Each pricing object has one or more pricing factors.

Examples

Success response

JSON format

{
  "RequestId": "79EE7556-0CFD-44EB-9CD6-B3B526E3A85F",
  "Code": "Success",
  "Message": "Successful！",
  "Success": true,
  "Data": {
    "PriceEntityInfoList": [
      {
        "PriceEntityCode": "instance_type",
        "PriceEntityName": "Elastic Compute Service (ECS) instance\n",
        "PriceFactorList": [
          {
            "PriceFactorCode": "vm_region_no",
            "PriceFactorName": "Region\n",
            "PriceFactorValueList": [
              "cn-shiwei-shenshu"
            ]
          }
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.