ListProvisionedProducts - Service Catalog - Alibaba Cloud Documentation Center

Queries product instances.

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:ListProvisionedProducts

get

*ProvisionedProduct

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

servicecatalog:UserLevel

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: ProvisionedProductName: performs exact matches by product instance name. Product instance names are not case-sensitive. FullTextSearch: performs full-text searches by product instance name. Fuzzy match is supported.	ProvisionedProductName
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 instance was created.	CreateTime
SortOrder	string	No	The sorting method. Valid values: Asc: the ascending order. Desc (default): 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
AccessLevelFilter	string	No	The access filter. Valid values: User: queries the product instances that are created by the current requester. This is the default value. Account: queries the product instances that belong to the current Alibaba Cloud account.	User

Response elements

Element	Type	Description	Example
	object	The response parameters.
ProvisionedProductDetails	array<object>	The product instances.
	object	The details of the product instance.
ProvisionedProductName	string	The name of the product instance.	DEMO-ECS实例
ProvisionedProductId	string	The ID of the product instance.	pp-bp1ddg1n2a****
ProvisionedProductArn	string	The Alibaba Cloud Resource Name (ARN) of the product instance.	acs:servicecatalog:cn-hangzhou:146611588617**:provisionedproduct/pp-bp1ddg1n2a**
ProductId	string	The ID of the product.	prod-bp18r7q127****
ProductName	string	The name of the product.	DEMO-创建ECS
ProductVersionId	string	The ID of the product version.	pv-bp15e79d26****
ProductVersionName	string	The name of the product version.	1.0
LastTaskId	string	The ID of the task that was last run.	task-bp1dmg242c****
LastProvisioningTaskId	string	The ID of the task that was last run on the product instance. The task can be one of the following types: LaunchProduct: a task that launches the product. UpdateProvisionedProduct: a task that updates the information about the product instance. TerminateProvisionedProduct: a task that terminates the product instance.	task-bp1dmg242c****
LastSuccessfulProvisioningTaskId	string	The ID of the last task that was successfully run on the product instance. The task can be one of the following types: LaunchProduct: a task that launches the product. UpdateProvisionedProduct: a task that updates the information about the product instance. TerminateProvisionedProduct: a task that terminates the product instance.	task-bp1dmg242c****
OwnerPrincipalType	string	The type of the Resource Access Management (RAM) entity to which the product instance belongs. Valid values: RamUser: a RAM user RamRole: a RAM role	RamUser
OwnerPrincipalId	string	The ID of the RAM entity to which the product instance belongs.	24477111603637****
Status	string	The state of the product instance. Valid values: Available: The product instance was available. UnderChange: The information about the product instance was being changed. Error: An exception occurred on the product instance.	Available
StatusMessage	string	The message that is returned for the status of the product instance. Note This parameter is returned only when Error is returned for the Status parameter.	Resource CREATE failed: terraform stack sc-146611588617**-pp-bp1ddg1n2a** failure...
CreateTime	string	The time when the product instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-05-23T09:46:27Z
PortfolioId	string	The ID of the product portfolio.	port-bp1yt7582g****
StackId	string	The ID of the Resource Orchestration Service (ROS) stack.	137e31df-3754-40b4-be2f-c793ad84****
StackRegionId	string	The ID of the region to which the ROS stack belongs.	cn-hangzhou
ProvisionedProductType	string	The type of the product instance. The value is fixed as RosStack, which indicates an ROS stack.	RosStack
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

Success response

JSON format

{
  "ProvisionedProductDetails": [
    {
      "ProvisionedProductName": "DEMO-ECS实例",
      "ProvisionedProductId": "pp-bp1ddg1n2a****",
      "ProvisionedProductArn": "acs:servicecatalog:cn-hangzhou:146611588617****:provisionedproduct/pp-bp1ddg1n2a****",
      "ProductId": "prod-bp18r7q127****",
      "ProductName": "DEMO-创建ECS",
      "ProductVersionId": "pv-bp15e79d26****",
      "ProductVersionName": "1.0",
      "LastTaskId": "task-bp1dmg242c****",
      "LastProvisioningTaskId": "task-bp1dmg242c****",
      "LastSuccessfulProvisioningTaskId": "task-bp1dmg242c****",
      "OwnerPrincipalType": "RamUser",
      "OwnerPrincipalId": "24477111603637****",
      "Status": "Available",
      "StatusMessage": "Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...",
      "CreateTime": "2022-05-23T09:46:27Z",
      "PortfolioId": "port-bp1yt7582g****",
      "StackId": "137e31df-3754-40b4-be2f-c793ad84****",
      "StackRegionId": "cn-hangzhou",
      "ProvisionedProductType": "RosStack"
    }
  ],
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "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.