All Products
Search

This Product

    Service Catalog:LaunchProduct

    Document Center

    Service Catalog:LaunchProduct

    Last Updated:Mar 27, 2026

    Launches a product.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    servicecatalog:LaunchProduct

    *ProvisionedProduct

    acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/*

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ProvisionedProductName

    string

    Yes

    The name of the product instance.

    The value must be 1 to 128 characters in length.

    DEMO-ECS Instance
    PortfolioId

    string

    No

    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****
    ProductId

    string

    Yes

    The ID of the product.

    prod-bp18r7q127****
    ProductVersionId

    string

    Yes

    The ID of the product version.

    pv-bp15e79d26****
    Parameters

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

    object

    No

    The input parameters of the template.

    ParameterKey

    string

    No

    The name of the input parameter for the template.

    instance_type
    ParameterValue

    string

    No

    The value of the input parameter for the template.

    ecs.s6-c1m1.small
    StackRegionId

    string

    Yes

    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
    Tags

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

    object

    No

    The custom tags that are specified by the end user.

    Key

    string

    No

    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
    Value

    string

    No

    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 elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The ID of the request.

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

    string

    The ID of the instance

    pp-bp1ddg1n2a****

    Examples

    Success response

    JSON format

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

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    500 InternalError A system error occurred.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.