CreateTemplate API reference - CloudOps Orchestration Service - Alibaba Cloud - CloudOps Orchestration Service

Creates 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

oos:CreateTemplate

create

*Template

acs:oos:{#regionId}:{#accountId}:template/*

oos:tag
oos:TLSVersion

ram:PassRole

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
TemplateName	string	Yes	The template name. The name can contain letters, digits, hyphens (-), and underscores (_), and can be up to 200 characters in length. The name cannot start with ALIYUN, ACS, ALIBABA, or ALICLOUD.	MyTemplate
Content	string	Yes	The template content. The content must be in JSON or YAML format and cannot exceed 64 KB in size.	{"FormatVersion": "OOS-2019-06-01", "Description": "Describe instances of given status", "Parameters": {"Status": {"Type": "String", "Description": "(Required) The status of the Ecs instance."}}, "Tasks": [{"Properties": {"Parameters": {"Status": "{{ Status }}"}, "API": "DescribeInstances", "Service": "Ecs"}, "Name": "foo", "Action": "ACS::ExecuteApi"}]}
Tags	object	No	The list of tag key-value pairs. You can specify 1 to 20 tag key-value pairs.	{"k1":"v1","k2":"v2"}
VersionName	string	No	The version name.	v2
ResourceGroupId	string	No	The resource group ID.	rg-acfmxsn4m4******

Response elements

Element	Type	Description	Example
	object
TemplateType	string	The template type.	Private
RequestId	string	The request ID.	20758A-585D-4A41-A9B2-28DA8F4F534F
Template	object	The template metadata.
Hash	string	The SHA-256 hash of the template content.	4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4
UpdatedDate	string	The time when the template was last updated.	2019-05-16T10:26:14Z
UpdatedBy	string	The user who last updated the template.	root(130900000)
Tags	object	The tags of the resource.	{ "k1":"v1", "k2":"v2" }
TemplateName	string	The template name.	MyTemplate
TemplateVersion	string	The template version. The version is in the format of "v" followed by a number that starts from 1.	v1
TemplateFormat	string	The template format. The system automatically determines the format, which is JSON or YAML.	JSON
Description	string	The template description.	Describe instances of given status
ResourceGroupId	string	The resource group ID.	rg-acfmxsn4m4******
CreatedBy	string	The user who created the template.	root(13090000)
CreatedDate	string	The time when the template was created.	2019-05-16T10:26:14Z
TemplateId	string	The template ID.	t-94753d38
HasTrigger	boolean	Indicates whether the template was successfully triggered.	true
ShareType	string	The sharing type of the template. The sharing type of user-created templates is Private.	Private

Examples

Success response

JSON format

{
  "TemplateType": "Private",
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "Template": {
    "Hash": "4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4",
    "UpdatedDate": "2019-05-16T10:26:14Z",
    "UpdatedBy": "root(130900000)",
    "Tags": {
      "k1": "v1",
      "k2": "v2"
    },
    "TemplateName": "MyTemplate",
    "TemplateVersion": "v1",
    "TemplateFormat": "JSON",
    "Description": "Describe instances of given status",
    "ResourceGroupId": "rg-acfmxsn4m4******",
    "CreatedBy": "root(13090000)",
    "CreatedDate": "2019-05-16T10:26:14Z",
    "TemplateId": "t-94753d38",
    "HasTrigger": true,
    "ShareType": "Private"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.