首页 运维编排服务 API参考 API目录 模板 GetTemplate - 获取模版

GetTemplate - 获取模版

获取一个模版,包括内容。

调试

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

调试

授权信息

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

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

请求参数

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

地域ID

cn-hangzhou
TemplateNamestring

模板名称。内容限制为字母、数字、中划线、下划线,长度200字符。

MyTemplate
TemplateVersionstring

模板版本。格式:“v”+数字。取值范围:v1-v200

v1

返回参数

名称类型描述示例值
object
Contentstring

模板内容

"FormatVersion: OOS-2019-06-01\nDescription:\n en: Creates an ECS image\n zh-cn: 创建一个ECS镜像\n name-en: Create Image\n name-zh-cn: 创建镜像\n categories:\n - image_manage\n - application_manage\nParameters:\n regionId:\n Type: String\n Label:\n en: RegionId\n zh-cn: 地域ID\n AssociationProperty: RegionId\n Default: '{{ ACS::RegionId }}'\n instanceId:\n Label:\n en: InstanceId\n zh-cn: ECS实例ID\n Type: String\n AssociationProperty: ALIYUN::ECS::Instance::InstanceId\n AssociationPropertyMetadata:\n RegionId: regionId\n imageName:\n Label:\n en: ImageName\n zh-cn: 新镜像的名称\n Type: String\n Description:\n en: <p class=\"p\">Note:</p> <ul class=\"ul\"> <li class=\"li\">Length is 2~128 English or Chinese characters</li> <li class=\"li\"><font color='red'>must start with big or small letters or Chinese, not http:// and https://. </font></li> <li class=\"li\">Can contain numbers, colons (:), underscores (_), or dashes (-). </li> </ul>\n zh-cn: <p class=\"p\">注意:</p> <ul class=\"ul\"> <li class=\"li\">长度为2~128个英文或中文字符</li> <li class=\"li\"><font color='red'>必须以大小字母或中文开头,不能以http://和https://开头。</font></li> <li class=\"li\">可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。</li> </ul>\n tags:\n Label:\n en: Tags\n zh-cn: 镜像标签\n Type: Json\n AssociationProperty: Tags\n AssociationPropertyMetadata:\n ShowSystem: false\n Default: []\n OOSAssumeRole:\n Label:\n en: OOSAssumeRole\n zh-cn: OOS扮演的RAM角色\n Type: String\n Default: OOSServiceRole\nRamRole: '{{ OOSAssumeRole }}'\nTasks:\n- Name: createImage\n Action: ACS::ECS::CreateImage\n Description:\n en: Create new image with the specified image name and instance ID\n zh-cn: 通过指定实例ID和镜像名称创建新的镜像\n Properties:\n regionId: '{{ regionId }}'\n imageName: '{{ imageName }}__on_{{ ACS::ExecutionId }}_at_{{ Acs::CurrentDate }}'\n instanceId: '{{ instanceId }}'\n tags: '{{tags}}'\n Outputs:\n imageId:\n ValueSelector: imageId\n Type: String\nOutputs:\n imageId:\n Type: String\n Value: '{{ createImage.imageId }}'\nMetadata:\n ALIYUN::OOS::Interface:\n ParameterGroups:\n - Parameters:\n - regionId\n - instanceId\n Label:\n default:\n zh-cn: 选择实例\n en: Select Ecs Instances\n - Parameters:\n - imageName\n - tags\n Label:\n default:\n zh-cn: 镜像设置\n en: Image Configure\n - Parameters:\n - OOSAssumeRole\n Label:\n default:\n zh-cn: 高级选项\n en: Control Options"
RequestIdstring

请求ID

5BBE2663-A18E-5261-9BBB-F4832F5294D9
Templateobject

模板元信息

Hashstring

模板内容的SHA256

40fb5e3e08ef6c8a499ff7cd8441194f518028ad08338a84cb70c023a64576f1
UpdatedDatestring

模板更新时间

2022-04-26T08:37:07Z
UpdatedBystring

模板更新者

ACS
TemplateTypestring

模板类型

Automation
Tagsobject

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

TemplateNamestring

模板名称

ACS-ECS-CreateImage
TemplateVersionstring

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

v15
TemplateFormatstring

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

YAML
Descriptionstring

模板描述

"{\"en\": \"Creates an ECS image\", \"zh-cn\": \"创建一个ECS镜像\", \"name-en\": \"Create Image\", \"name-zh-cn\": \"创建镜像\", \"categories\": [\"image_manage\", \"application_manage\"]}"
ResourceGroupIdstring

资源组ID

rg-acfmxsn4m4******
CreatedBystring

模板创建者

ACS
CreatedDatestring

模板创建时间

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

版本名称

version15
TemplateIdstring

模板ID

t-4bdb1745c171401883a2
HasTriggerboolean

是否含有触发器

false
ShareTypestring

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

Public

示例

请求示例

http(s)://[Endpoint]/?Action=GetTemplate
&RegionId=cn-hangzhou
&TemplateName=MyTemplate
&TemplateVersion=v1
&公共请求参数

正常返回示例

JSON格式

{
    "Content": "\"FormatVersion: OOS-2019-06-01\\nDescription:\\n  en:  Creates an ECS image\\n  zh-cn: 创建一个ECS镜像\\n  name-en: Create Image\\n  name-zh-cn: 创建镜像\\n  categories:\\n    - image_manage\\n    - application_manage\\nParameters:\\n  regionId:\\n    Type: String\\n    Label:\\n      en: RegionId\\n      zh-cn: 地域ID\\n    AssociationProperty: RegionId\\n    Default: '{{ ACS::RegionId }}'\\n  instanceId:\\n    Label:\\n      en: InstanceId\\n      zh-cn: ECS实例ID\\n    Type: String\\n    AssociationProperty: ALIYUN::ECS::Instance::InstanceId\\n    AssociationPropertyMetadata:\\n      RegionId: regionId\\n  imageName:\\n    Label:\\n      en: ImageName\\n      zh-cn: 新镜像的名称\\n    Type: String\\n    Description:\\n      en: &lt;p class=\\\"p\\\"&gt;Note:&lt;/p&gt; &lt;ul class=\\\"ul\\\"&gt; &lt;li class=\\\"li\\\"&gt;Length is 2~128 English or Chinese characters&lt;/li&gt; &lt;li class=\\\"li\\\"&gt;&lt;font color='red'&gt;must start with big or small letters or Chinese, not http:// and https://. &lt;/font&gt;&lt;/li&gt; &lt;li class=\\\"li\\\"&gt;Can contain numbers, colons (:), underscores (_), or dashes (-). &lt;/li&gt; &lt;/ul&gt;\\n      zh-cn: &lt;p class=\\\"p\\\"&gt;注意:&lt;/p&gt; &lt;ul class=\\\"ul\\\"&gt; &lt;li class=\\\"li\\\"&gt;长度为2~128个英文或中文字符&lt;/li&gt; &lt;li class=\\\"li\\\"&gt;&lt;font color='red'&gt;必须以大小字母或中文开头,不能以http://和https://开头。&lt;/font&gt;&lt;/li&gt; &lt;li class=\\\"li\\\"&gt;可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。&lt;/li&gt; &lt;/ul&gt;\\n  tags:\\n    Label:\\n      en: Tags\\n      zh-cn: 镜像标签\\n    Type: Json\\n    AssociationProperty: Tags\\n    AssociationPropertyMetadata:\\n      ShowSystem: false\\n    Default: []\\n  OOSAssumeRole:\\n    Label:\\n      en: OOSAssumeRole\\n      zh-cn: OOS扮演的RAM角色\\n    Type: String\\n    Default: OOSServiceRole\\nRamRole: '{{ OOSAssumeRole }}'\\nTasks:\\n- Name: createImage\\n  Action: ACS::ECS::CreateImage\\n  Description:\\n    en: Create new image with the specified image name and instance ID\\n    zh-cn: 通过指定实例ID和镜像名称创建新的镜像\\n  Properties:\\n    regionId: '{{ regionId }}'\\n    imageName: '{{ imageName }}__on_{{ ACS::ExecutionId }}_at_{{ Acs::CurrentDate }}'\\n    instanceId: '{{ instanceId }}'\\n    tags: '{{tags}}'\\n  Outputs:\\n    imageId:\\n      ValueSelector: imageId\\n      Type: String\\nOutputs:\\n  imageId:\\n    Type: String\\n    Value: '{{ createImage.imageId }}'\\nMetadata:\\n  ALIYUN::OOS::Interface:\\n    ParameterGroups:\\n      - Parameters:\\n          - regionId\\n          - instanceId\\n        Label:\\n          default:\\n            zh-cn: 选择实例\\n            en: Select Ecs Instances\\n      - Parameters:\\n          - imageName\\n          - tags\\n        Label:\\n          default:\\n            zh-cn: 镜像设置\\n            en: Image Configure\\n      - Parameters:\\n          - OOSAssumeRole\\n        Label:\\n          default:\\n            zh-cn: 高级选项\\n            en: Control Options\"",
    "RequestId": "5BBE2663-A18E-5261-9BBB-F4832F5294D9",
    "Template": {
        "Hash": "40fb5e3e08ef6c8a499ff7cd8441194f518028ad08338a84cb70c023a64576f1",
        "UpdatedDate": "2022-04-26T08:37:07Z",
        "UpdatedBy": "ACS",
        "TemplateType": "Automation",
        "TemplateName": "ACS-ECS-CreateImage",
        "TemplateVersion": "v15",
        "TemplateFormat": "YAML",
        "Description": "\"{\\\"en\\\": \\\"Creates an ECS image\\\", \\\"zh-cn\\\": \\\"创建一个ECS镜像\\\", \\\"name-en\\\": \\\"Create Image\\\", \\\"name-zh-cn\\\": \\\"创建镜像\\\", \\\"categories\\\": [\\\"image_manage\\\", \\\"application_manage\\\"]}\"",
        "ResourceGroupId": "rg-acfmxsn4m4******",
        "CreatedBy": "ACS",
        "CreatedDate": "2019-05-16T10:26:14Z",
        "VersionName": "version15",
        "TemplateId": "t-4bdb1745c171401883a2",
        "HasTrigger": false,
        "ShareType": "Public"
    }
}

XML格式

<GetTemplateResponse>
    <Content>"FormatVersion: OOS-2019-06-01\nDescription:\n  en:  Creates an ECS image\n  zh-cn: 创建一个ECS镜像\n  name-en: Create Image\n  name-zh-cn: 创建镜像\n  categories:\n    - image_manage\n    - application_manage\nParameters:\n  regionId:\n    Type: String\n    Label:\n      en: RegionId\n      zh-cn: 地域ID\n    AssociationProperty: RegionId\n    Default: '{{ ACS::RegionId }}'\n  instanceId:\n    Label:\n      en: InstanceId\n      zh-cn: ECS实例ID\n    Type: String\n    AssociationProperty: ALIYUN::ECS::Instance::InstanceId\n    AssociationPropertyMetadata:\n      RegionId: regionId\n  imageName:\n    Label:\n      en: ImageName\n      zh-cn: 新镜像的名称\n    Type: String\n    Description:\n      en: &lt;p class=\"p\"&gt;Note:&lt;/p&gt; &lt;ul class=\"ul\"&gt; &lt;li class=\"li\"&gt;Length is 2~128 English or Chinese characters&lt;/li&gt; &lt;li class=\"li\"&gt;&lt;font color='red'&gt;must start with big or small letters or Chinese, not http:// and https://. &lt;/font&gt;&lt;/li&gt; &lt;li class=\"li\"&gt;Can contain numbers, colons (:), underscores (_), or dashes (-). &lt;/li&gt; &lt;/ul&gt;\n      zh-cn: &lt;p class=\"p\"&gt;注意:&lt;/p&gt; &lt;ul class=\"ul\"&gt; &lt;li class=\"li\"&gt;长度为2~128个英文或中文字符&lt;/li&gt; &lt;li class=\"li\"&gt;&lt;font color='red'&gt;必须以大小字母或中文开头,不能以http://和https://开头。&lt;/font&gt;&lt;/li&gt; &lt;li class=\"li\"&gt;可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。&lt;/li&gt; &lt;/ul&gt;\n  tags:\n    Label:\n      en: Tags\n      zh-cn: 镜像标签\n    Type: Json\n    AssociationProperty: Tags\n    AssociationPropertyMetadata:\n      ShowSystem: false\n    Default: []\n  OOSAssumeRole:\n    Label:\n      en: OOSAssumeRole\n      zh-cn: OOS扮演的RAM角色\n    Type: String\n    Default: OOSServiceRole\nRamRole: '{{ OOSAssumeRole }}'\nTasks:\n- Name: createImage\n  Action: ACS::ECS::CreateImage\n  Description:\n    en: Create new image with the specified image name and instance ID\n    zh-cn: 通过指定实例ID和镜像名称创建新的镜像\n  Properties:\n    regionId: '{{ regionId }}'\n    imageName: '{{ imageName }}__on_{{ ACS::ExecutionId }}_at_{{ Acs::CurrentDate }}'\n    instanceId: '{{ instanceId }}'\n    tags: '{{tags}}'\n  Outputs:\n    imageId:\n      ValueSelector: imageId\n      Type: String\nOutputs:\n  imageId:\n    Type: String\n    Value: '{{ createImage.imageId }}'\nMetadata:\n  ALIYUN::OOS::Interface:\n    ParameterGroups:\n      - Parameters:\n          - regionId\n          - instanceId\n        Label:\n          default:\n            zh-cn: 选择实例\n            en: Select Ecs Instances\n      - Parameters:\n          - imageName\n          - tags\n        Label:\n          default:\n            zh-cn: 镜像设置\n            en: Image Configure\n      - Parameters:\n          - OOSAssumeRole\n        Label:\n          default:\n            zh-cn: 高级选项\n            en: Control Options"</Content>
    <RequestId>5BBE2663-A18E-5261-9BBB-F4832F5294D9</RequestId>
    <Template>
        <Hash>40fb5e3e08ef6c8a499ff7cd8441194f518028ad08338a84cb70c023a64576f1</Hash>
        <UpdatedDate>2022-04-26T08:37:07Z</UpdatedDate>
        <UpdatedBy>ACS</UpdatedBy>
        <TemplateType>Automation</TemplateType>
        <TemplateName>ACS-ECS-CreateImage</TemplateName>
        <TemplateVersion>v15</TemplateVersion>
        <TemplateFormat>YAML</TemplateFormat>
        <Description>"{\"en\": \"Creates an ECS image\", \"zh-cn\": \"创建一个ECS镜像\", \"name-en\": \"Create Image\", \"name-zh-cn\": \"创建镜像\", \"categories\": [\"image_manage\", \"application_manage\"]}"</Description>
        <ResourceGroupId>rg-acfmxsn4m4******</ResourceGroupId>
        <CreatedBy>ACS</CreatedBy>
        <CreatedDate>2019-05-16T10:26:14Z</CreatedDate>
        <VersionName>version15</VersionName>
        <TemplateId>t-4bdb1745c171401883a2</TemplateId>
        <HasTrigger>false</HasTrigger>
        <ShareType>Public</ShareType>
    </Template>
</GetTemplateResponse>

错误码

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

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