首页 >运维编排服务 >API参考 >API目录 >模板 >CreateTemplate - 创建一个模版

CreateTemplate - 创建一个模版

调用CreateTemplate创建一个模版。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
oos:CreateTemplateWRITE
  • OOS
    acs:oos:{#regionId}:{#accountId}:template/*
  • oos:tag

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID

cn-hangzhou
TemplateNamestring

模板名称。内容限制为字母、数字、中划线、下划线,长度200字符,且不能以ALIYUN、ACS、ALIBABA、ALICLOUD开头。

MyTemplate
Contentstring

模板内容。JSON或YAML格式,长度限制为 64 KB。

{"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"}]}
Tagsobject

标签键和值列表, 标签键值对数量范围是1至20。

{"k1":"v1","k2":"v2"}
VersionNamestring

版本名称。

v2
ResourceGroupIdstring

资源组ID。

rg-acfmxsn4m4******

返回参数

名称类型描述示例值
object
TemplateTypestring

模版类型。

Private
RequestIdstring

请求ID

20758A-585D-4A41-A9B2-28DA8F4F534F
Templateobject

模板元信息

Hashstring

模板内容的SHA256

4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4
UpdatedDatestring

模板更新时间

2019-05-16T10:26:14Z
UpdatedBystring

模板更新者

root(130900000)
Tagsobject

该资源的标签

{ "k1":"v1", "k2":"v2" }
TemplateNamestring

模板名称

MyTemplate
TemplateVersionstring

模板版本。以“v”+数字的形式,数字从1开始。

v1
TemplateFormatstring

模板格式。系统字段判断,为JSON或YAML。

JSON
Descriptionstring

模板说明

Describe instances of given status
ResourceGroupIdstring

资源组ID

rg-acfmxsn4m4******
CreatedBystring

模板创建者

root(13090000)
CreatedDatestring

模板创建时间

2019-05-16T10:26:14Z
TemplateIdstring

模板ID

t-94753d38
HasTriggerboolean

是否成功触发

true
ShareTypestring

模板共享类型。目前用户创建的模板的共享类型均为 Private。

Private

示例

请求示例

http(s)://[Endpoint]/?Action=CreateTemplate
&RegionId=cn-hangzhou
&TemplateName=MyTemplate
&Content={"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"}]}
&VersionName=v2
&ResourceGroupId=rg-acfmxsn4m4******
&公共请求参数

正常返回示例

JSON格式

{
    "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
    "Template": {
        "CreatedBy": "root(130900000)",
        "CreatedDate": "2019-05-27T08:46:33Z",
        "UpdatedBy": "root(1309000000)",
        "UpdatedDate": "2019-05-27T08:46:33Z",
        "Description": "Describe instances of given status",
        "Hash": "4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4",
        "ShareType": "Private",
        "Tags": {
            "k1": "v1",
            "k2": "v2"
        },
        "ResourceGroupId": "rg-acfmxsn4m4******",
        "TemplateFormat": "JSON",
        "TemplateName": "MyTemplate",
        "TemplateId": "t-94753eeaef8",
        "TemplateVersion": "v1"
    }
}

XML格式

<CreateTemplateResponse>
    <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>
    <Template>
        <CreatedBy>root(130900000)</CreatedBy>
        <CreatedDate>2019-05-27T08:46:33Z</CreatedDate>
        <UpdatedBy>root(1309000000)</UpdatedBy>
        <UpdatedDate>2019-05-27T08:46:33Z</UpdatedDate>
        <Description>Describe instances of given status</Description>
        <Hash>4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4</Hash>
        <ShareType>Private</ShareType>
        <Tags>
            <k1>v1</k1>
            <k2>v2</k2>
        </Tags>
        <ResourceGroupId>rg-acfmxsn4m4******</ResourceGroupId>
        <TemplateFormat>JSON</TemplateFormat>
        <TemplateName>MyTemplate</TemplateName>
        <TemplateId>t-94753eeaef8</TemplateId>
        <TemplateVersion>v1</TemplateVersion>
    </Template>
</CreateTemplateResponse>

错误码

访问错误中心查看更多错误码。

阿里云首页 运维编排服务 相关技术圈