ListProductsAsAdmin - Service Catalog - Alibaba Cloud Documentation Center

Queries products as an administrator.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

servicecatalog:ListProductsAsAdmin

get

*Product

acs:servicecatalog:{#regionId}:{#accountId}:product/*

None

Request parameters

Parameter	Type	Required	Description	Example
PortfolioId	string	No	The ID of the product portfolio.	port-bp1yt7582g****
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-创建ECS
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 elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	0FEEF92D-4052-5202-87D0-3D8EC16F81BF
ProductDetails	array<object>	The products.
	object	The information about the product.
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.	这是一个产品描述
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-创建ECS
ProviderName	string	The provider of the product.	IT团队
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

Success response

JSON format

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "ProductDetails": [
    {
      "ProductArn": "acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****",
      "Description": "这是一个产品描述",
      "CreateTime": "2022-04-12T06:10:37Z",
      "ProductId": "prod-bp18r7q127****",
      "ProductName": "DEMO-创建ECS",
      "ProviderName": "IT团队",
      "ProductType": "Ros",
      "TemplateType": "RosTerraformTemplate"
    }
  ],
  "TotalCount": 2,
  "PageNumber": 1,
  "PageSize": 10
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	A system error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.