All Products
Search
Document Center

BSS OpenAPI:QueryPriceEntityList

Last Updated:Mar 01, 2024

Queries the billable items of a service.

Operation description

You can call this operation to query the billable items of a service. A billable item is the minimum unit used to calculate costs.

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
bss:DescribeProductRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CommodityCodestringYes

The code of the service.

ecs

Response parameters

ParameterTypeDescriptionExample
object

The schema of the response.

RequestIdstring

The ID of the request.

79EE7556-0CFD-44EB-9CD6-B3B526E3A85F
Codestring

The HTTP status code.

Success
Messagestring

The message that is returned.

Successful!
Successboolean

Indicates whether the request is successful.

true
Dataobject

The data that is returned.

PriceEntityInfoListobject []

The information about the billable items.

PriceEntityCodestring

The code of the billable item.

instance_type
PriceEntityNamestring

The name of the billable item.

Elastic Compute Service (ECS) instance
PriceFactorListobject []

The factors of the billable item.

PriceFactorCodestring

The code of the factor.

vm_region_no
PriceFactorNamestring

The name of the factor.

Region
PriceFactorValueListarray

The values of the factor.

string

The value of the factor.

cn-shiwei-shenshu

A service has one or more billable items, and each billable item has one or more factors.

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-04The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Lang