All Products
Search
Document Center

Service Catalog:LaunchProduct

Last Updated:Mar 03, 2024

Launches a product.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
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.

Note If 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****
Parametersobject []No

The input parameters of the template.

You can specify up to 200 parameters.

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

The name of the input parameter for the template.

instance_type
ParameterValuestringNo

The value of the input parameter for the template.

ecs.s6-c1m1.small
StackRegionIdstringYes

The ID of the region to which the Resource Orchestration Service (ROS) stack belongs.

For more information about how to obtain the regions that are supported by ROS, see DescribeRegions .

cn-hangzhou
Tagsobject []No

The custom tags that are specified by the end user.

Maximum value of N: 20.

Note
  • The Tags parameter is optional. If you specify the Tags parameter, you must specify the Tags.N.Key and Tags.N.Value parameters.

  • The tag is propagated to each stack resource that supports the tag feature.

KeystringNo

The tag key of the custom tag.

The tag key must be 1 to 128 characters in length and cannot contain http:// or https://. It cannot start with acs: or aliyun.

k1
ValuestringNo

The tag value of the custom tag.

The tag value can be up to 128 characters in length and cannot start with acs:. It cannot contain http:// or https://.

v1

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

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

The ID of the instance

pp-bp1ddg1n2a****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
500InternalErrorA system error occurred.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history