ListPortfolios - Service Catalog - Alibaba Cloud Documentation Center

Queries product portfolios.

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.

Operation	Access level	Resource type	Condition key	Association operation
servicecatalog:ListPortfolios	List	ServiceCatalog acs:servicecatalog:{#regionId}:{#accountId}:portfolio/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProductId	string	No	The ID of the product.	prod-bp18r7q127****
Filters	array	No	The filter conditions.
	object	No
Key	string	No	The name of the filter condition. Valid values: PortfolioName: performs exact matches by product portfolio name. Product portfolio names are not case-sensitive. FullTextSearch: performs full-text searches by product portfolio name, product portfolio provider, or product portfolio description. Fuzzy match is supported.	PortfolioName
Value	string	No	The value of the filter condition.	DEMO-IT services
SortBy	string	No	The field that is used to sort the queried data. The value is fixed as CreateTime, which specifies the time when the product portfolio 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 product portfolios that are created by using the current account. This is the default value. Import: the product portfolios that are imported from other accounts. All: all available product portfolios.	Local

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
PortfolioDetails	array	The product portfolios.
	object	The details of the product portfolio.
Description	string	The description of the product portfolio.	The description of the product portfolio.
PortfolioName	string	The name of the product portfolio.	DEMO-IT services
CreateTime	string	The time when the product portfolio 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:11:12Z
ProviderName	string	The provider of the product portfolio.	IT team
PortfolioId	string	The ID of the product portfolio.	port-bp1yt7582g****
PortfolioArn	string	The Alibaba Cloud Resource Name (ARN) of the product portfolio.	acs:servicecatalog:cn-hangzhou:146611588617**:portfolio/port-bp1yt7582g**
RequestId	string	The ID of the request.	0FEEF92D-4052-5202-87D0-3D8EC16F81BF
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

{
  "PortfolioDetails": [
    {
      "Description": "The description of the product portfolio.\n",
      "PortfolioName": "DEMO-IT services\n",
      "CreateTime": "2022-04-12T06:11:12Z",
      "ProviderName": "IT team\n",
      "PortfolioId": "port-bp1yt7582g****",
      "PortfolioArn": "acs:servicecatalog:cn-hangzhou:146611588617****:portfolio/port-bp1yt7582g****"
    }
  ],
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "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.