ListProductsAsEndUser - Service Catalog - Alibaba Cloud Documentation Center

Queries products as a user.

Operation description

Make sure that you are granted the permissions to manage relevant products as a user by an administrator. For more information, see Manage access permissions.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
servicecatalog:ListProductsAsEndUser	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Filters	array<object>	No	The filter conditions.
	object	No
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 data. The default value is CreateTime, which specifies the time when the product was created.	CreateTime
SortOrder	string	No	The method that is used to sort the returned entries. Valid values: Asc: sorts the entries in ascending order. Desc (default): sorts the entries in 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

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	0FEEF92D-4052-5202-87D0-3D8EC16F81BF
ProductSummaries	array<object>	The products.
productSummary	object	The information about the product.
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****
ProductArn	string	The Alibaba Cloud Resource Name (ARN) of the product.	acs:servicecatalog:cn-hangzhou:146611588617**:product/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
HasDefaultLaunchOption	boolean	Indicates whether the default launch option exists. Valid values: true: The default launch option exists. In this case, the PortfolioId parameter is not required when the product is launched or when the information about the product instance is updated. false: The default launch option does not exist. In this case, the PortfolioId parameter is required when the product is launched or when the information about the product instance is updated. For more information about the PortfolioId parameter, see ListLaunchOptions . Note If the product is added to only one product portfolio, the default launch option exists. If the product is added to multiple product portfolios, multiple launch options exist at the same time. However, no default launch options exist.	true
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.	100
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",
  "ProductSummaries": [
    {
      "Description": "The description of the product.\n",
      "CreateTime": "2022-04-12T06:10:37Z",
      "ProductId": "prod-bp18r7q127****",
      "ProductArn": "acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****",
      "ProductName": "DEMO-Create an ECS instance\n",
      "ProviderName": "IT team\n",
      "ProductType": "Ros",
      "HasDefaultLaunchOption": true,
      "TemplateType": "RosTerraformTemplate"
    }
  ],
  "TotalCount": 100,
  "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	View Change Details