All Products
Search
Document Center

BSS OpenAPI:QueryProductList

Last Updated:Mar 01, 2024

Queries the information about all Alibaba Cloud services.

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
bssapi:QueryProductListREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
QueryTotalCountbooleanNo

Specifies whether to return the total number of services. Default value: false.

true
PageNumintegerYes

The page number of the page to return.

1
PageSizeintegerNo

The number of entries to return on each page. Default value: 20.

10

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code returned.

Success
Messagestring

The message returned.

This API is not applicable for caller.
RequestIdstring

The ID of the request.

94858229-2758-4663-A7D0-99490D541F15
Successboolean

Indicates whether the request was successful.

true
Dataobject

The information about all Alibaba Cloud services.

PageNuminteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned on each page.

10
TotalCountinteger

The total number of services.

449
ProductListobject []

The service definitions.

ProductNamestring

The name of the service.

CDN (Pay-as-you-go)
ProductTypestring

The type of the service.

CDN
SubscriptionTypestring

The billing method. Valid values:

  • Subscription: subscription
  • PayAsYouGo: pay-as-you-go
PayAsYouGo
ProductCodestring

The code of the service.

cdn

Examples

Sample success responses

JSONformat

{
  "Code": "Success",
  "Message": "This API is not applicable for caller.",
  "RequestId": "94858229-2758-4663-A7D0-99490D541F15",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "PageSize": 10,
    "TotalCount": 449,
    "ProductList": {
      "Product": [
        {
          "ProductName": "CDN (Pay-as-you-go)\n",
          "ProductType": "CDN",
          "SubscriptionType": "PayAsYouGo",
          "ProductCode": "cdn"
        }
      ]
    }
  }
}

Error codes

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