CreateProduct - Service Catalog - Alibaba Cloud Documentation Center

Creates a product.

Operation description

Before you call the CreateProduct 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:CreateProduct

create

*Product

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

None

Request parameters

Parameter	Type	Required	Description	Example
ProductName	string	Yes	The name of the product. The value must be 1 to 128 characters in length.	DEMO-创建ECS
ProductType	string	Yes	The type of the product. Set the value to Ros, which specifies Resource Orchestration Service (ROS).	Ros
Description	string	No	The description of the product. The value must be 1 to 128 characters in length.	这是一个产品描述
ProviderName	string	Yes	The provider of the product. The value must be 1 to 128 characters in length.	IT团队
ProductVersionParameters	object	No	The information about the product version.
ProductVersionName	string	No	The name of the product version. The value must be 1 to 128 characters in length.	1.0
TemplateType	string	No	The type of the template. Set the value to RosTerraformTemplate, which indicates the Terraform template that is supported by Resource Orchestration Service (ROS).	RosTerraformTemplate
TemplateUrl	string	No	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
Description	string	No	The description of the product version. The value must be 1 to 128 characters in length.	这是一个产品版本描述
Guidance	string	No	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
Active	boolean	No	Specifies whether to enable the product version. Valid values: true (default) false	true
TemplateType	string	No	The type of the product template. Valid values: RosTerraformTemplate: the Terraform template that is supported by ROS. RosStandardTemplate: the standard ROS template.	RosTerraformTemplate

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	0FEEF92D-4052-5202-87D0-3D8EC16F81BF
ProductId	string	The ID of the product.	prod-bp18r7q127****
ProductVersionId	string	The ID of the product version.	pv-bp15e79d26****

Examples

Success response

JSON format

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "ProductId": "prod-bp18r7q127****",
  "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.