GetTemplate_资源编排_API文档-阿里云OpenAPI开发者门户

接口说明

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

流控信息

请求速率为500/60(s)。更多流控信息，请前往配额中心查看

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

ros:GetTemplate	Get	stack acs:ros:{#regionId}:{#accountId}:stack/{#stackId} template acs:ros:*:{#accountId}:template/{#templateId}	无	无

请求参数

字段名称	字段详情
StackIdstring	资源栈 ID。展开详情示例值:4a6c9851-3b0f-4f5f-b4ca-a14bf691****参考取值来源: UpdateStack ListStacks CreateStack GetStackInstance
RegionIdstring	模板所属资源栈或资源栈组的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。示例值:cn-hangzhou参考取值来源: DescribeRegions
ChangeSetIdstring	更改集 ID。展开详情示例值:1f6521a4-05af-4975-afe9-bc4b45ad****参考取值来源: ListChangeSets CreateChangeSet
TemplateIdstring	模板 ID。展开详情示例值:5ecd1e10-b0e9-4389-a565-e4c15efc****参考取值来源: UpdateTemplate ListTemplates CreateTemplate
TemplateVersionstring	模板版本。仅在指定 TemplateId 时生效。展开详情示例值:v1参考取值来源: ListTemplateVersions UpdateTemplate
TemplateStagestring	模板阶段。仅在指定 StackId、ChangeSetId 或 StackGroupName 时生效。展开详情示例值:Processed
IncludePermissionstring	是否查询模板共享信息。取值：展开详情示例值:Enabled
StackGroupNamestring	资源栈组名称。展开详情示例值:MyStackGroup参考取值来源: GetStackGroup CreateStackGroup ListStackGroups ImportStacksToStackGroup
IncludeTagsstring	是否查询标签信息。取值：展开详情示例值:Enabled

请求说明

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

返回参数

字段名称	字段详情
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 时返回该参数。展开详情示例值:2020-11-18T08:49:26
StackGroupNamestring	资源栈组名称。仅在指定 StackGroupName 时返回该参数。示例值:MyStackGroup
TemplateVersionstring	模板版本。仅在指定 TemplateId 时返回该参数。展开详情示例值:v1
TemplateBodystring	模板内容。示例值:{"ROSTemplateFormatVersion": "2015-09-01"}
ChangeSetIdstring	更改集 ID。仅在指定 ChangeSetId 时返回该参数。示例值:e85abe0c-6528-43fb-ae93-fdf8de22****
OwnerIdstring	模板所属阿里云账号 ID。仅在指定 TemplateId 时返回该参数。示例值:151266687691****
UpdateTimestring	模板的最后更新时间。仅在指定 TemplateId 时返回该参数。展开详情示例值:2020-12-07T06:11:48
Permissionsarray<object>	模板的共享状态。仅在指定 TemplateId，且 IncludePermission 为 Enabled 时返回该参数。展开详情
TemplateNamestring	模板的名称。仅在指定 TemplateId 时返回该参数。展开详情示例值:MyTemplate
RegionIdstring	模板所属资源栈或资源栈组的地域 ID。仅在指定 StackId、ChangeSetId 或 StackGroupName 时返回该参数。示例值:cn-hangzhou
TemplateIdstring	模板的 ID。仅在指定 TemplateId 时返回。展开详情示例值:a52f81be-496f-4e1c-a286-8852ab54****
StackIdstring	资源栈 ID。仅在指定 StackId 时返回该参数。示例值:4a6c9851-3b0f-4f5f-b4ca-a14bf691****
ShareTypestring	模板的共享类型。仅在指定 TemplateId 时返回该参数。展开详情示例值:Private
ResourceGroupIdstring	资源组 ID。示例值:rg-acfmxazb4ph6aiy****
Interfacestring	界面描述信息。示例值:{}
Tagsarray<object>	模板的标签。
AdditionalInfoobject	公共模板的补充信息。示例值:{"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	变更返回参数
	2022-06-09	新增请求参数IncludeTags 变更返回参数
	2021-12-20	变更返回参数