文档

UpdateTemplate - 更新一个已经存在的模板

更新时间:

更新一个已经存在的模板。

调试

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

授权信息

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

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

请求参数

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

地域 ID

cn-hangzhou
TemplateNamestring

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

MyTemplate
Contentstring

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

{ "FormatVersion": "OOS-2019-06-01", "Description": { "en": "Bulky starts the ECS instances", "zh-cn": "批量启动ECS实例", "name-en": "Bulky Start Instances", "name-zh-cn": "批量启动实例" }, "Parameters": { "regionId": { "Type": "String", "Label": { "en": "RegionId", "zh-cn": "地域ID" }, "AssociationProperty": "RegionId", "Default": "{{ ACS::RegionId }}" }, "targets": { "Type": "Json", "Label": { "en": "TargetInstance", "zh-cn": "目标实例" }, "AssociationProperty": "Targets", "AssociationPropertyMetadata": { "ResourceType": "ALIYUN::ECS::Instance", "RegionId": "regionId" } }, "rateControl": { "Label": { "en": "RateControl", "zh-cn": "任务执行的并发比率" }, "Type": "Json", "AssociationProperty": "RateControl", "Default": { "Mode": "Concurrency", "MaxErrors": 0, "Concurrency": 10 } }, "OOSAssumeRole": { "Label": { "en": "OOSAssumeRole", "zh-cn": "OOS扮演的RAM角色" }, "Type": "String", "Default": "OOSServiceRole" } }, "RamRole": "{{ OOSAssumeRole }}", "Tasks": [ { "Name": "getInstance", "Description": { "en": "Views the ECS instances", "zh-cn": "获取ECS实例" }, "Action": "ACS::SelectTargets", "Properties": { "ResourceType": "ALIYUN::ECS::Instance", "RegionId": "{{ regionId }}", "Filters": [ "{{ targets }}" ] }, "Outputs": { "instanceIds": { "Type": "List", "ValueSelector": "Instances.Instance[].InstanceId" } } }, { "Name": "startInstance", "Action": "ACS::ECS::StartInstance", "Description": { "en": "Starts the ECS instances", "zh-cn": "启动实例" }, "Properties": { "regionId": "{{ regionId }}", "instanceId": "{{ ACS::TaskLoopItem }}" }, "Loop": { "RateControl": "{{ rateControl }}", "Items": "{{ getInstance.instanceIds }}" } } ], "Outputs": { "instanceIds": { "Type": "List", "Value": "{{ getInstance.instanceIds }}" } } }
Tagsobject

标签键及值,键值对数量限制为 1 至 20。

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

模版版本名称。

v2
ResourceGroupIdstring

资源组 ID。

rg-acfmxsn4m4******

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID

2075899A-585D-4A41-A9B2-28DF4F534F
Templateobject

模板元信息

Hashstring

模板内容的 SHA256

4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4
UpdatedDatestring

模板更新时间

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

模板更新者

root(1309000)
Tagsobject

标签键及值,键值对数量限制为 1 至 20。

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

模板名称

MyTemplate
TemplateVersionstring

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

v2
TemplateFormatstring

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

JSON
Descriptionstring

模板说明

Describe instances of given status
ResourceGroupIdstring

资源组 ID。

rg-acfmxsn4m4******
CreatedBystring

模板创建者

root(130920000)
CreatedDatestring

模板创建时间

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

模板 ID

t-94753deed38
HasTriggerboolean

是否成功触发

true
ShareTypestring

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

Private

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2024-06-26API 内部配置变更,不影响调用查看变更详情