All Products
Search
Document Center

BSS OpenAPI:QueryCommodityList

Last Updated:Mar 01, 2024

Queries the information about a service based on the service code.

Operation description

You can call this operation to query the information about a service based on the service code.

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
ProductCodestringYes

The code of the service.

ecs

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

Id of the request

CC706AAC-75A6-55B5-9AB7-7D171C6C7655
Messagestring

The returned message.

Successful!
Successboolean

Indicates whether the information about the service was queried.

True
Codestring

The HTTP status code.

NotApplicable
Dataobject

The returned data.

CommodityListobject []

The information about the service.

CommodityCodestring

The code of the service, which is the same as that on the Billing Management page.

ecs
CommodityNamestring

The name of the service.

ECS (Pay-As-You-Go)
ChargeTypestring

The payment type. Valid values: POSTPAY (pay-as-you-go) and PREPAY (subscription).

POSTPAY

Examples

Sample success responses

JSONformat

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

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