指定资源栈、资源栈组、更改集、自定义模板其中任意信息获取模板详情。
接口说明
本文将提供一个示例，查询杭州地域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 | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 时生效。 取值范围：v1～v65000、Draft。 共享模板取值范围：v1～v65000。 | v1 |
| TemplateStage | string | 否 | 模板阶段。仅在指定 StackId、ChangeSetId 或 StackGroupName 时生效。 取值：
| Processed |
| IncludePermission | string | 否 | 是否查询模板共享信息。取值：
说明
仅限模板拥有者查询。
| Enabled |
| StackGroupName | string | 否 | 资源栈组名称。 说明
您必须且仅能指定 StackId、ChangeSetId、StackGroupName 和 TemplateId 其中一个参数。
| MyStackGroup |
| IncludeTags | string | 否 | 是否查询标签信息。取值：
说明
仅在指定 TemplateId 参数时生效。
| Enabled |
关于公共请求参数的详情，请参见公共参数。
返回参数
示例
正常返回示例
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": [
"其他"
]
},
"Provider": "ROS",
"Categories": [
"Solution"
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-11-28 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2022-06-09 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 404 | ChangeSetNotFound | The ChangeSet ({name}) of Stack ({stack}) could not be found. | 更改集不存在。name 为更改集名称或 ID，stack 为资源栈名称或 ID。 |
| 404 | ChangeSetNotFound | The ChangeSet {ID} could not be found. | 更改集不存在。ID 为更改集 ID。 |
| 404 | StackNotFound | The Stack ({name}) could not be found. | 资源栈不存在。name 为资源栈名称或 ID。 |
| 404 | TemplateNotFound | The Template { ID } could not be found. | 模板不存在。ID 为模板 ID。 |
| 404 | TemplateNotFound | The Template { ID } with version { version } could not be found. | 模板或指定版本不存在。ID 为模板 ID，version 为模板版本。 |
| 404 | StackGroupNotFound | The StackGroup ({name}) could not be found. | 资源栈组不存在。name 为资源栈组名称。 |