All Products
Search
Document Center

Service Catalog:CreateProduct

Last Updated:Apr 07, 2024

Creates a product.

Operation description

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

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
ProductNamestringYes

The name of the product.

The value must be 1 to 128 characters in length.

DEMO-Create an ECS instance
ProductTypestringYes

The type of the product.

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

Ros
DescriptionstringNo

The description of the product.

The value must be 1 to 128 characters in length.

The description of the product.
ProviderNamestringYes

The provider of the product.

The value must be 1 to 128 characters in length.

IT team
ProductVersionParametersobjectNo

The information about the product version.

ProductVersionNamestringNo

The name of the product version.

The value must be 1 to 128 characters in length.

1.0
TemplateTypestringNo

The type of the template.

Set the value to RosTerraformTemplate, which indicates the Terraform template that is supported by Resource Orchestration Service (ROS).

RosTerraformTemplate
TemplateUrlstringNo

The URL of the template.

To obtain the URL of a template, you can call the CreateTemplate operation.

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

The description of the product version.

The value must be 1 to 128 characters in length.

The description of the product version.
GuidancestringNo

The recommended product version. Valid values:

  • Default (default): No product version is recommended.
  • Recommended: the stable version.
  • Latest: the latest version.
  • Deprecated: the version that is about to be deprecated.
Default
ActivebooleanNo

Specifies whether to enable the product version. Valid values:

  • true (default)
  • false
true
TemplateTypestringNo

The type of the product template. Valid values:

  • RosTerraformTemplate: the Terraform template that is supported by ROS.
  • RosStandardTemplate: the standard ROS template.
RosTerraformTemplate

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

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

The ID of the product.

prod-bp18r7q127****
ProductVersionIdstring

The ID of the product version.

pv-bp15e79d26****

Examples

Sample success responses

JSONformat

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

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
2024-02-27The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: TemplateType
2023-12-26The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.