AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

GetTemplate - 查询模板详情

更新时间：
复制为 MD 格式
产品详情
我的收藏

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

接口说明

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

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ros:GetTemplate

get

stack

acs:ros:{#regionId}:{#accountId}:stack/{#stackId}

template

acs:ros:*:{#accountId}:template/{#templateId}

 无 无

请求参数

名称

类型

必填

描述

示例值
StackId

string

否

资源栈 ID。

说明

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

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

string

否

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

cn-hangzhou
ChangeSetId

string

否

更改集 ID。

说明

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

1f6521a4-05af-4975-afe9-bc4b45ad****
TemplateId

string

否

模板 ID。

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

说明

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

5ecd1e10-b0e9-4389-a565-e4c15efc****
TemplateVersion

string

否

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

取值范围：v1～v65000、Draft。 共享模板取值范围：v1～v65000。

v1
TemplateStage

string

否

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

取值：

  • Processed（默认值）：返回解析转换后的模板。

  • Original：返回用户指定的原始模板。

Processed
IncludePermission

string

否

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

  • Enabled：查询。

  • Disabled（默认值）：不查询。

说明

仅限模板拥有者查询。

Enabled
StackGroupName

string

否

资源栈组名称。

说明

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

MyStackGroup
IncludeTags

string

否

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

  • Enabled：查询。

  • Disabled（默认值）：不查询。

说明

仅在指定 TemplateId 参数时生效。

Enabled

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

返回参数

名称

类型

描述

示例值

object

TemplateARN

string

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

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

string

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

ROS template for create ECS instance.
RequestId

string

请求 ID。

B288A0BE-D927-4888-B0F7-B35EF84****
CreateTime

string

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

说明

  • 如果指定了 TemplateVersion，则返回指定版本模板的创建时间。

  • 如果未指定 TemplateVersion，则返回默认版本模板的创建时间。

2020-11-18T08:49:26
StackGroupName

string

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

MyStackGroup
TemplateVersion

string

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

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

v1
TemplateBody

string

模板内容。

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

string

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

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

string

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

151266687691****
UpdateTime

string

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

说明

  • 如果指定了 TemplateVersion，则返回指定版本模板的最后更新时间。

  • 如果未指定 TemplateVersion，则返回模板的最后更新时间。

2020-12-07T06:11:48
Permissions

array<object>

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

说明

  • 如果未指定 TemplateVersion，或者 TemplateVersion 不生效，则返回模板的共享状态。

  • 如果指定了 TemplateVersion，并且 TemplateVersion 生效，则返回版本关联模板的共享状态。

object

VersionOption

string

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

取值：

  • AllVersions：共享模板所有版本。

  • Latest：只共享模板最新版本。模板版本增加时，共享的版本也随之变化，始终保持最新版本。

  • Current：只共享模板当前最新版本。模板版本增加时，共享的版本不变。

  • Specified：只共享模板指定的单个版本。

AllVersions
AccountId

string

共享的阿里云账号。

142437958638****
ShareOption

string

共享选项。

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

ShareToAccounts
TemplateVersion

string

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

当指定参数 TemplateVersion 为 Draft 时，如果 Draft 版本存在，则该返回值为 Draft；如果 Draft 版本不存在或已被清除，则该返回值为当前最新版本。

取值范围：v1~v65000、Draft。

v1
ShareSource

string

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

  • ROS：通过 ROS 控制台或 API 建立共享关系。

  • ResourceDirectory：在资源管理服务中通过资源共享功能为资源目录中的账号建立共享关系。

说明

  • 来自 ROS 的共享与来自 ResourceDirectory 的共享拥有独立的配额。

  • 无法通过 ROS 控制台或 API 取消或覆盖来自 ResourceDirectory 的共享。

  • 来自 ResourceDirectory 的共享可以覆盖来自 ROS 的共享。

ROS
TemplateName

string

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

说明

  • 如果指定了 TemplateVersion，则返回版本关联的模板名称。

  • 如果未指定 TemplateVersion，则返回模板的名称。

MyTemplate
RegionId

string

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

cn-hangzhou
TemplateId

string

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

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

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

string

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

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

ShareType

string

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

取值：

  • Private：模板为用户自己所拥有。

  • Shared：模板由其他用户所共享。

Private
ResourceGroupId

string

资源组 ID。

rg-acfmxazb4ph6aiy****
Interface

string

界面描述信息。

{}
Tags

array<object>

模板的标签。

object

模板的标签。

Key

string

模板的标签键。

usage
Value

string

模板的标签值。

test
AdditionalInfo

object

公共模板的补充信息。

{"DeploymentDuration":null,"Title":"Self-Built_ElasticSearch_Snapshot_Saved_To_OSS","Labels":{"ResourceTypes":["ALIYUN::ECS::Instance","ALIYUN::ECS::SecurityGroup","ALIYUN::ECS::VPC","ALIYUN::ECS::VSwitch","ALIYUN::OSS::Bucket","ALIYUN::ROS::WaitCondition","ALIYUN::ROS::WaitConditionHandle"],"DeployTypes":["ROS"],"ApplicationScenes":["other"]},"Provider":"ROS","Categories":["Solution"]}

示例

正常返回示例

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"
    }
  ],
  "AdditionalInfo": {
    "DeploymentDuration": null,
    "Title": "Self-Built_ElasticSearch_Snapshot_Saved_To_OSS",
    "Labels": {
      "ResourceTypes": [
        "ALIYUN::ECS::Instance",
        "ALIYUN::ECS::SecurityGroup",
        "ALIYUN::ECS::VPC",
        "ALIYUN::ECS::VSwitch",
        "ALIYUN::OSS::Bucket",
        "ALIYUN::ROS::WaitCondition",
        "ALIYUN::ROS::WaitConditionHandle"
      ],
      "DeployTypes": [
        "ROS"
      ],
      "ApplicationScenes": [
        "other"
      ]
    },
    "Provider": "ROS",
    "Categories": [
      "Solution"
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。

上一篇：UpdateTemplate - 更新模板下一篇：ListTemplates - 查询模板列表