All Products
Search
Document Center

Service Catalog:ListProductsAsAdmin

Last Updated:Jul 25, 2025

Queries products as an administrator.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
servicecatalog:ListProductsAsAdminget
*Product
acs:servicecatalog:{#regionId}:{#accountId}:product/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PortfolioIdstringNo

The ID of the product portfolio.

port-bp1yt7582g****
Filtersarray<object>No

The filter conditions.

objectNo
KeystringNo

The name of the filter condition. Valid values:

  • ProductName: performs exact matches by product name. Product names are not case-sensitive.
  • FullTextSearch: performs full-text searches by product name, product provider, or product description. Fuzzy match is supported.
ProductName
ValuestringNo

The value of the filter condition.

DEMO-Create an ECS instance
SortBystringNo

The field that is used to sort the queried data.

Set the value to CreateTime, which specifies the time when the product was created.

CreateTime
SortOrderstringNo

The order in which you want to sort the queried data. Valid values:

  • Asc: the ascending order
  • Desc: the descending order
Desc
PageNumberintegerNo

The number of the page to return.

Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page.

Valid values: 1 to 100. Default value: 10.

10
ScopestringNo

The query scope. Valid values:

  • Local: the products that are created by using the current account. This is the default value.
  • Import: the products that are imported from other accounts.
  • All: all available products.
Local

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

0FEEF92D-4052-5202-87D0-3D8EC16F81BF
ProductDetailsarray<object>

The products.

productDetailobject

The information about the product.

ProductArnstring

The Alibaba Cloud Resource Name (ARN) of the product.

acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****
Descriptionstring

The description of the product.

The description of the product.
CreateTimestring

The time when the product was created.

The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.

2022-04-12T06:10:37Z
ProductIdstring

The product ID.

prod-bp18r7q127****
ProductNamestring

The name of the product.

DEMO-Create an ECS instance
ProviderNamestring

The provider of the product.

IT team
ProductTypestring

The type of the product.

The value is set to Ros, which indicates Resource Orchestration Service (ROS).

Ros
TemplateTypestring

The type of the product template. Valid values:

  • RosTerraformTemplate: the Terraform template that is supported by ROS.
  • RosStandardTemplate: the standard ROS template.
RosTerraformTemplate
TotalCountinteger

The total number of entries returned.

2
PageNumberinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

10

Examples

Sample success responses

JSONformat

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "ProductDetails": [
    {
      "ProductArn": "acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****",
      "Description": "The description of the product.\n",
      "CreateTime": "2022-04-12T06:10:37Z",
      "ProductId": "prod-bp18r7q127****",
      "ProductName": "DEMO-Create an ECS instance\n",
      "ProviderName": "IT team\n",
      "ProductType": "Ros",
      "TemplateType": "RosTerraformTemplate"
    }
  ],
  "TotalCount": 2,
  "PageNumber": 1,
  "PageSize": 10
}

Error codes

HTTP status codeError codeError message
500InternalErrorA system error occurred.

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

Change history

Change timeSummary of changesOperation
2024-02-27The response structure of the API has changedView Change Details