CreateProvisionedProductPlan-阿里云帮助中心

Creates a plan.

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

create

*All Resource

*

servicecatalog:UserLevel

None

Request parameters

Parameter	Type	Required	Description	Example
PlanName	string	Yes	The plan name. The value must be 1 to 128 characters in length.	DEMO-ECS Instance
PlanType	string	Yes	The plan type. Set the value to Ros, which specifies Resource Orchestration Service (ROS).	Ros
ProvisionedProductName	string	Yes	The product instance name. The value must be 1 to 128 characters in length.	DEMO-ECS Instance
PortfolioId	string	No	The product portfolio ID. Note If PortfolioId is not required, you do not need to specify PortfolioId. If PortfolioId is required, you must specify PortfolioId. For more information about how to obtain the value of PortfolioId, see ListLaunchOptions.	port-bp1yt7582g****
ProductId	string	Yes	The product ID.	prod-bp18r7q127****
ProductVersionId	string	Yes	The product version ID.	pv-bp15e79d26****
Parameters	array<object>	No	An array that consists of the parameters in the template. You can specify up to 200 parameters. Note If you specify Parameters, you must specify ParameterKey and ParameterValue.
	object	No
ParameterKey	string	No	The name of the parameter in the template.	instance_type
ParameterValue	string	No	The value of the parameter in the template.	ecs.s6-c1m1.small
StackRegionId	string	Yes	The ID of the region to which the ROS stack belongs. For more information about how to obtain the regions that are supported by ROS, see DescribeRegions.	cn-hangzhou
Tags	array<object>	No	An array that consists of custom tags. Maximum value of N: 20. Note If you specify Tags, you must specify Tags.N.Key and Tags.N.Value. The tag of a stack is propagated to each resource that supports the tag feature in the stack.
	object	No
Key	string	No	The key of the custom tag. The key can be up to 128 characters in length, and cannot start with `acs:` or `aliyun`. The tag key cannot contain `http://` or `https://`.	k1
Value	string	No	The value of the custom tag. The value can be up to 128 characters in length, and cannot start with `acs:`. The tag value cannot contain `http://` or `https://`.	v1
OperationType	string	No	The type of the operation that you want the plan to perform. 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
Description	string	No	The description of the plan. The value must be 1 to 128 characters in length.	Create ECS

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0FEEF92D-4052-5202-87D0-3D8EC16F81BF
PlanId	string	The plan ID.	plan-bp1jvmdk2k****
ProvisionedProductId	string	The product instance ID.	pp-bp1ddg1n2a****

Examples

Success response

JSON format

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "PlanId": "plan-bp1jvmdk2k****",
  "ProvisionedProductId": "pp-bp1ddg1n2a****"
}

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.