CreateProvisionedProductPlan - Service Catalog - Alibaba Cloud Documentation Center

Creates a plan.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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	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.
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	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.
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 an ECS instance.

Response parameters

Parameter	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

Sample success responses

JSONformat

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

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.