ListProvisionedProductPlans - Service Catalog - Alibaba Cloud Documentation Center

Queries a list of plans. You can query plans from the end user dimension or from the review dimension.

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

list

*All Resource

*

servicecatalog:UserLevel
servicecatalog:ApprovalActor

None

Request parameters

Parameter	Type	Required	Description	Example
Filters	array<object>	No	An array that consists of filter conditions.
	object	No
Key	string	No	The name of the filter condition. Valid values: ProvisionedProductPlanName: performs exact matches by plan name. Plan names are not case-sensitive. ProvisionedProductPlanApprover: performs exact matches by reviewer. You must specify a reviewer in the `RamUser/RamRole:<Name of the reviewer>` format. You can specify multiple reviewers. ProvisionedProductPlanApproverName: performs matches by reviewer name. You must specify the Resource Access Management (RAM) entity name of the reviewer. You can specify multiple reviewer names. ProvisionedProductPlanStatus: performs matches by plan status. You must specify the state of the plan. You can specify multiple states. ProvisionedProductPlanOwnerUid: performs exact matches by ID of Alibaba Cloud account to which a plan belongs. FullTextSearch: performs fuzzy full-text searches by plan name.	FullTextSearch
Value	string	No	The value of the filter condition.	ECS
SortBy	string	No	The information based on which you want to sort the query results. Set the value to CreateTime, which specifies the creation time of plans.	CreateTime
SortOrder	string	No	The order in which you want to sort the query results. Valid values: Asc: the ascending order Desc (default): the descending order. Valid values: Asc : Asc Desc : Desc	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. Minimum value: 1. Default value: 10.	10
AccessLevelFilter	string	No	The access filter. Valid values: User (default): queries the plans that are created by the current requester. Account: queries the plans that belong to the current Alibaba Cloud account. ResourceDirectory: queries the plans that belong to the current resource directory.	User
ApprovalFilter	string	No	The access filter of the review dimension. Valid values: ReceivedRequests: queries plans that are pending for review. ApprovalHistory: queries review history. AccountRequests: queries all plans that belong to the current Alibaba Cloud account. AccountRequests: queries all plans that belong to the current Alibaba Cloud account.	ReceivedRequests
ProvisionedProductId	string	No	The ID of the product instance.	pp-bp1ddg1n2a****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	0FEEF92D-4052-5202-87D0-3D8EC16F****
PlanDetails	array<object>	An array that consists of plans.
	array<object>
PlanId	string	The ID of the plan.	plan-bp18mmdh2u****
PlanName	string	The name of the plan.	DEMO-创建ECS-637****
PlanType	string	The type of the plan. The value is fixed as Ros, which indicates Resource Orchestration Service (ROS).	Ros
PortfolioId	string	The ID of the product portfolio.	port-bp1438kf2j****
ProductId	string	The ID of the product.	prod-bp1rtrnh2c****
ProductVersionId	string	The ID of the product version.	pv-bp19udk22v****
ProvisionedProductId	string	The ID of the product instance.	pp-bp1c35162d****
Parameters	array<object>	An array that consists of the parameters in the template.
	object
ParameterKey	string	The name of the parameter in the template.	role_name
ParameterValue	string	The value of the parameter in the template.	Test-8
ProvisionedProductName	string	The name of the product instance.	rds-MYSQL-875****
StackId	string	The ID of the ROS stack.	2599090a-309e-4306-b989-17ba66a9****
StackRegionId	string	The ID of the region to which the ROS stack belongs.	cn-hangzhou
Status	string	The state of the plan. Valid values: PreviewInProgress: The plan is being prechecked. PreviewSuccess: The precheck is successful. PreviewFailed: The precheck fails. ApplicationInProgress: The plan is being reviewed. ApplicationApproved: The plan is approved. ApplicationRejected: The approval is rejected. ExecuteInProgress: The plan is being run. ExecuteSuccess: The plan is run. ExecuteFailed: The plan fails to be run. Canceled: The plan is canceled.	PreviewSuccess
StatusMessage	string	The message returned for the state. Note This parameter is returned only when PreviewFailed or ExecuteFailed is returned for the Status parameter.	Create stack failed: Resource CREATE failed: terraform stack sc-146611588617**-pp-bp1ddg1n2a** failure...
CreateTime	string	The time when the plan was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-09-13T02:01:22Z
UpdateTime	string	The last time when the task was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-07-18T06:02:35.075Z
Tags	array<object>	An array that consists of custom tags.
	object
Key	string	The key of the custom tag.	k1
Value	string	The value of the custom tag.	v1
OperationType	string	The purpose of the plan. Valid values: LaunchProduct: launches the product. This is the default value. UpdateProvisionedProduct: updates the information about the product instance. TerminateProvisionedProduct: terminates the product instance.	LaunchProduct
AssignedApprovers	array<object>	An array that consists of reviewers.
	object
PrincipalType	string	The type of the RAM entity of the reviewer. Valid values: RamUser: a RAM user RamRole: a RAM role	RamUser
PrincipalName	string	The RAM entity name of the reviewer.	endUser
ProductName	string	The name of the product.	创建ECS
Description	string	The description of the plan.	开发团队使用
OwnerPrincipalType	string	The type of the RAM entity to which the plan belongs. Valid values: RamUser: a RAM user RamRole: a RAM role	RamUser
OwnerPrincipalId	string	The ID of the RAM entity to which the plan belongs.	24477111603637****
OwnerPrincipalName	string	The name of the RAM entity to which the plan belongs.	enduser
Uid	string	The ID of the Alibaba Cloud account to which the plan belongs.	146611588617****
TotalCount	integer	The total number of entries returned.	16
PageNumber	integer	The page number of the returned page. Pages start from page 1. Default value: 1.	1
PageSize	integer	The number of entries returned per page. Valid values: 1 to 100. Minimum value: 1. Default value: 10.	10

Examples

Success response

JSON format

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F****",
  "PlanDetails": [
    {
      "PlanId": "plan-bp18mmdh2u****",
      "PlanName": "DEMO-创建ECS-637****",
      "PlanType": "Ros",
      "PortfolioId": "port-bp1438kf2j****",
      "ProductId": "prod-bp1rtrnh2c****",
      "ProductVersionId": "pv-bp19udk22v****",
      "ProvisionedProductId": "pp-bp1c35162d****",
      "Parameters": [
        {
          "ParameterKey": "role_name",
          "ParameterValue": "Test-8"
        }
      ],
      "ProvisionedProductName": "rds-MYSQL-875****",
      "StackId": "2599090a-309e-4306-b989-17ba66a9****",
      "StackRegionId": "cn-hangzhou",
      "Status": "PreviewSuccess",
      "StatusMessage": "Create stack failed: Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...",
      "CreateTime": "2022-09-13T02:01:22Z",
      "UpdateTime": "2022-07-18T06:02:35.075Z",
      "Tags": [
        {
          "Key": "k1",
          "Value": "v1"
        }
      ],
      "OperationType": "LaunchProduct",
      "AssignedApprovers": [
        {
          "PrincipalType": "RamUser",
          "PrincipalName": "endUser"
        }
      ],
      "ProductName": "创建ECS",
      "Description": "开发团队使用",
      "OwnerPrincipalType": "RamUser",
      "OwnerPrincipalId": "24477111603637****\n",
      "OwnerPrincipalName": "enduser",
      "Uid": "146611588617****"
    }
  ],
  "TotalCount": 16,
  "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.