All Products
Search
Document Center

Service Catalog:CreateProvisionedProductPlan

Last Updated:Nov 15, 2022

Creates a plan.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
servicecatalog:CreateProvisionedProductPlanWrite
  • ServiceCatalog
    acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/*
  • ServiceCatalog
    acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
PlanNamestringYes

The name of the plan.

The value must be 1 to 128 characters in length.

DEMO-ECS instance
PlanTypestringYes

The type of the plan.

Set the value to Ros, which specifies Resource Orchestration Service (ROS).

Ros
ProvisionedProductNamestringYes

The name of the product instance.

The value must be 1 to 128 characters in length.

DEMO-ECS instance
PortfolioIdstringNo

The ID of the product portfolio.

NoteIf the PortfolioId parameter is not required, you do not need to specify the PortfolioId parameter. If the PortfolioId parameter is required, you must specify the PortfolioId parameter. For more information about how to obtain the value of the PortfolioId parameter, see ListLaunchOptions.
port-bp1yt7582g****
ProductIdstringYes

The ID of the product.

prod-bp18r7q127****
ProductVersionIdstringYes

The ID of the product version.

pv-bp15e79d26****
ParametersarrayNo

An array that consists of the parameters in the template. The parameters are specified by the administrator.

You can specify up to 200 parameters.

NoteThis parameter is optional. If you specify the Parameters parameter, you must specify the ParameterKey and ParameterValue parameters.
objectNo
ParameterKeystringNo

The name of the parameter in the template.

instance_type
ParameterValuestringNo

The value of the parameter in the template.

ecs.s6-c1m1.small
StackRegionIdstringYes

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

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

0FEEF92D-4052-5202-87D0-3D8EC16F81BF
PlanIdstring

The ID of the plan.

plan-bp1jvmdk2k****
ProvisionedProductIdstring

The ID of the product instance.

pp-bp1ddg1n2a****

Example

Normal return example

JSONFormat

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

Error codes

Http codeError codeError message
500InternalErrorA system error occurred.

For a list of error codes, visit the API error center.