首页 资源编排 API参考 API目录 模板相关接口 GetTemplate - 查询模板详情

GetTemplate - 查询模板详情

指定资源栈、资源栈组、更改集、自定义模板其中任意信息获取模板详情。

接口说明

本文将提供一个示例,查询杭州地域cn-hangzhou模板ID为5ecd1e10-b0e9-4389-a565-e4c15efc****的模板详细信息。

调试

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

调试

授权信息

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

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

请求参数

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

资源栈ID。

说明您必须且仅能指定StackId、ChangeSetId、StackGroupName和TemplateId其中一个参数。
4a6c9851-3b0f-4f5f-b4ca-a14bf691****
RegionIdstring

模板所属资源栈或资源栈组的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

cn-hangzhou
ChangeSetIdstring

更改集ID。

说明您必须且仅能指定StackId、ChangeSetId、StackGroupName和TemplateId其中一个参数。
1f6521a4-05af-4975-afe9-bc4b45ad****
TemplateIdstring

模板ID。

支持共享的模板和私有模板。共享模板TemplateId与TemplateARN相同,使用该值查询。

说明您必须且仅能指定StackId、ChangeSetId、StackGroupName和TemplateId其中一个参数。
5ecd1e10-b0e9-4389-a565-e4c15efc****
TemplateVersionstring

模板版本。仅在指定TemplateId时生效。
如果为共享模板,仅当共享模板中的VersionOption取值为AllVersions时,支持指定该参数。更多信息,请参见SetTemplatePermission.

取值范围:v1~v100。

v1
TemplateStagestring

模板阶段。仅在指定StackId、ChangeSetId或StackGroupName时生效。

取值:

  • Processed(默认值):返回解析转换后的模板。
  • Original:返回用户指定的原始模板。
Processed
IncludePermissionstring

是否查询模板共享信息。取值:

  • Enabled:查询。

  • Disabled(默认值):不查询。

说明仅限模板拥有者查询。
Enabled
StackGroupNamestring

资源栈组名称。

说明您必须且仅能指定StackId、ChangeSetId、StackGroupName和TemplateId其中一个参数。
MyStackGroup
IncludeTagsstring

是否查询标签信息。取值:

  • Enabled:查询。
  • Disabled(默认值):不查询。
说明仅在指定TemplateId参数时生效。
Enabled

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object
TemplateARNstring

模板ARN。仅在指定TemplateId时返回该参数。

acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****
Descriptionstring

模板描述。仅在指定TemplateId时返回该参数。

ROS template for create ECS instance.
RequestIdstring

请求ID。

B288A0BE-D927-4888-B0F7-B35EF84****
CreateTimestring

模板创建时间。仅在指定TemplateId时返回该参数。

说明
  • 如果指定了TemplateVersion,则返回指定版本模板的创建时间。
    • 如果未指定TemplateVersion,则返回默认版本模板的创建时间。
    2020-11-18T08:49:26
    StackGroupNamestring

    资源栈组名称。仅在指定StackGroupName时返回该参数。

    MyStackGroup
    TemplateVersionstring

    模板版本。仅在指定TemplateId时返回该参数。
    如果未指定TemplateVersion,或TemplateVersion未生效,则该参数表示模板当前版本。

    如果为共享模板,当且仅当VersionOption为AllVersions时,支持返回该参数。

    v1
    TemplateBodystring

    模板内容。

    {"ROSTemplateFormatVersion": "2015-09-01"}
    ChangeSetIdstring

    更改集ID。仅在指定ChangeSetId时返回该参数。

    e85abe0c-6528-43fb-ae93-fdf8de22****
    OwnerIdstring

    模板所属阿里云账号ID。仅在指定TemplateId时返回该参数。

    151266687691****
    UpdateTimestring

    模板的最后更新时间。仅在指定TemplateId时返回该参数。

    说明
  • 如果指定了TemplateVersion,则返回指定版本模板的最后更新时间。
    • 如果未指定TemplateVersion,则返回模板的最后更新时间。
    2020-12-07T06:11:48
    Permissionsobject []

    模板的共享状态。仅在指定TemplateId,且IncludePermission为Enabled时返回该参数。

    说明
  • 如果未指定TemplateVersion,或者TemplateVersion不生效,则返回模板的共享状态。
    • 如果指定了TemplateVersion,并且TemplateVersion生效,则返回版本关联模板的共享状态。
    VersionOptionstring

    共享版本选项。仅在ShareOption取值为ShareToAccounts时返回该参数。

    取值:

    • AllVersions:共享模板所有版本。
    • Latest:只共享模板最新版本。模板版本增加时,共享的版本也随之变化,始终保持最新版本。
    • Current:只共享模板当前最新版本。模板版本增加时,共享的版本不变。
    • Specified:只共享模板指定的单个版本。
    AllVersions
    AccountIdstring

    共享的阿里云账号。

    142437958638****
    ShareOptionstring

    共享选项。

    取值:ShareToAccounts,表示共享给其他阿里云账号。

    ShareToAccounts
    TemplateVersionstring

    共享的模板版本。当ShareOption为ShareToAccounts,且VersionOption为Specified或Current时返回该参数。

    取值范围:v1~v100。

    v1
    ShareSourcestring

    共享关系的建立来源。 取值:

    • ROS:通过ROS控制台或API建立共享关系。
    • ResourceDirectory:在资源管理服务中通过资源共享功能为资源目录中的账号建立共享关系。
    说明
  • 来自ROS的共享与来自ResourceDirectory的共享拥有独立的配额。
    • 无法通过ROS控制台或API取消或覆盖来自ResourceDirectory的共享。
    • 来自ResourceDirectory的共享可以覆盖来自ROS的共享。
    ROS
    TemplateNamestring

    模板的名称。仅在指定TemplateId时返回该参数。

    说明
  • 如果指定了TemplateVersion,则返回版本关联的模板名称。
    • 如果未指定TemplateVersion,则返回模板的名称。
    MyTemplate
    RegionIdstring

    模板所属资源栈或资源栈组的地域ID。仅在指定StackId、ChangeSetId或StackGroupName时返回该参数。

    cn-hangzhou
    TemplateIdstring

    模板的ID。仅在指定TemplateId时返回。

    如果是共享模板,返回结果与TemplateARN相同。

    a52f81be-496f-4e1c-a286-8852ab54****
    StackIdstring

    资源栈ID。仅在指定StackId时返回该参数。

    4a6c9851-3b0f-4f5f-b4ca-a14bf691****
    ShareTypestring

    模板的共享类型。仅在指定TemplateId时返回该参数。

    取值:

    • Private:模板为用户自己所拥有。
    • Shared:模板由其他用户所共享。
    Private
    ResourceGroupIdstring

    资源组ID。

    rg-acfmxazb4ph6aiy****
    Interfacestring

    界面描述信息。

    {}
    Tagsobject []

    模板的标签。

    Keystring

    模板的标签键。

    usage
    Valuestring

    模板的标签值。

    test

    示例

    正常返回示例

    JSON格式

    {
      "TemplateARN": "acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****",
      "Description": "ROS template for create ECS instance.",
      "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84****",
      "CreateTime": "2020-11-18T08:49:26",
      "StackGroupName": "MyStackGroup",
      "TemplateVersion": "v1",
      "TemplateBody": "{\"ROSTemplateFormatVersion\": \"2015-09-01\"}",
      "ChangeSetId": "e85abe0c-6528-43fb-ae93-fdf8de22****",
      "OwnerId": "151266687691****",
      "UpdateTime": "2020-12-07T06:11:48",
      "Permissions": [
        {
          "VersionOption": "AllVersions",
          "AccountId": "142437958638****",
          "ShareOption": "ShareToAccounts",
          "TemplateVersion": "v1",
          "ShareSource": "ROS"
        }
      ],
      "TemplateName": "MyTemplate",
      "RegionId": "cn-hangzhou",
      "TemplateId": "a52f81be-496f-4e1c-a286-8852ab54****",
      "StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****\t",
      "ShareType": "Private",
      "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
      "Interface": "{}",
      "Tags": [
        {
          "Key": "usage",
          "Value": "test"
        }
      ]
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2022-06-09OpenAPI 入参发生变更,OpenAPI 返回结构发生变更
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:IncludeTags
    出参OpenAPI 返回结构发生变更
    HttpCode错误码错误信息描述
    404ChangeSetNotFoundThe ChangeSet ({name}) of Stack ({stack}) could not be found.更改集不存在。name为更改集名称或ID,stack为资源栈名称或ID。
    404ChangeSetNotFoundThe ChangeSet {ID} could not be found.更改集不存在。ID为更改集ID。
    404StackNotFoundThe Stack ({name}) could not be found.资源栈不存在。name为资源栈名称或ID。
    404TemplateNotFoundThe Template { ID } could not be found.模板不存在。ID为模板ID。
    404TemplateNotFoundThe Template { ID } with version { version } could not be found.模板或指定版本不存在。ID为模板ID,version为模板版本。
    404StackGroupNotFoundThe StackGroup ({name}) could not be found.资源栈组不存在。name为资源栈组名称。
    阿里云首页 资源编排 相关技术圈