ListProductsAsAdmin - Service Catalog - Alibaba Cloud Documentation Center

Queries products as an administrator.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
PortfolioId	string	No	The ID of the product portfolio.	port-bp1yt7582g****
Filters	object []	No	The filter conditions.
Key	string	No	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
Value	string	No	The value of the filter condition.	DEMO-Create an ECS instance
SortBy	string	No	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
SortOrder	string	No	The order in which you want to sort the queried data. Valid values: Asc: the ascending order Desc: the descending order	Desc
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Default value: 10.	10
Scope	string	No	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

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	0FEEF92D-4052-5202-87D0-3D8EC16F81BF
ProductDetails	object []	The products.
ProductArn	string	The Alibaba Cloud Resource Name (ARN) of the product.	acs:servicecatalog:cn-hangzhou:146611588617**:product/prod-bp18r7q127**
Description	string	The description of the product.	The description of the product.
CreateTime	string	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
ProductId	string	The product ID.	prod-bp18r7q127****
ProductName	string	The name of the product.	DEMO-Create an ECS instance
ProviderName	string	The provider of the product.	IT team
ProductType	string	The type of the product. The value is set to Ros, which indicates Resource Orchestration Service (ROS).	Ros
TemplateType	string	The type of the product template. Valid values: RosTerraformTemplate: the Terraform template that is supported by ROS. RosStandardTemplate: the standard ROS template.	RosTerraformTemplate
TotalCount	integer	The total number of entries returned.	2
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	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 code	Error code	Error message
500	InternalError	A system error occurred.

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

Change history

Change time

Summary of changes

Operation

2024-02-27

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.