All Products
Search
Document Center

Service Catalog:CreateProductVersion

Last Updated:Mar 27, 2026

Creates a product version.

Operation description

Before you call the CreateProductVersion operation, you must call the CreateTemplate operation to create a template.

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:CreateProductVersion

create

*Product

acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}

None None

Request parameters

Parameter

Type

Required

Description

Example

ProductVersionName

string

Yes

The name of the product version.

The value must be 1 to 128 characters in length.

1.0

TemplateType

string

Yes

The type of the product template. Valid values:

  • RosTerraformTemplate: the Terraform template that is supported by Resource Orchestration Service (ROS).

  • RosStandardTemplate: the standard ROS template.

RosTerraformTemplate

TemplateUrl

string

Yes

The URL of the template.

For more information about how to obtain the URL of a template, see CreateTemplate.

oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json

Description

string

No

The description of the product version.

The value must be 1 to 128 characters in length.

This is a product version description

Guidance

string

No

The recommendation information. Valid values:

  • Default: No recommendation information is provided. This is the default value.

  • Recommended: the recommendation version.

  • Latest: the latest version.

  • Deprecated: the version that is about to be discontinued.

Default

Active

boolean

No

Specifies whether the product version is active. Valid values:

  • true: The product version is active. This is the default value.

  • false: The product version is inactive.

true

ProductId

string

Yes

The ID of the product to which the product version belongs.

prod-bp18r7q127****

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The ID of the request.

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

ProductVersionId

string

The ID of the product version.

pv-bp15e79d26****

Examples

Success response

JSON format

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "ProductVersionId": "pv-bp15e79d26****"
}

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.