All Products
Search
Document Center

Service Catalog:LaunchProduct

Last Updated:Jul 25, 2025

Launches a product.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
servicecatalog:LaunchProduct
*ProvisionedProduct
acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/*
    none
none

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****
Parametersarray<object>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.
objectNo

The input parameters of the template.

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
Tagsarray<object>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.

objectNo

The custom tags that are specified by the end user.

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