Creates a plan.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| servicecatalog:CreateProvisionedProductPlan | create | *All Resources * |
| 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
| |
| 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 | k1 |
| Value | string | No | The value of the custom tag. The value can be up to 128 characters in length, and cannot start with | v1 |
| OperationType | string | No | The type of the operation that you want the plan to perform. Valid values:
| 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
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.