GetTemplateSummary - 获取新模板或者现有模板的信息 - 资源编排

通过指定模板、资源栈、资源栈组、更改集其中任意信息查询模板资源详情。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ros:GetTemplateSummary	get	Stack acs:ros:{#regionId}:{#accountId}:stack/{#StackId}	无	无

请求参数

名称	类型	必填	描述	示例值
StackId	string	否	资源栈 ID。您必须且仅能指定 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、StackGroupName 其中一个参数。	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
TemplateBody	string	否	模板的结构。长度为 1~524,288 个字节。如果长度较大，建议通过 HTTP POST+Body Param 的方式，将参数放在请求体中进行传递，避免 URL 过长而导致请求失败。您必须且仅能指定 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、StackGroupName 其中一个参数。	{"ROSTemplateFormatVersion":"2015-09-01"}
RegionId	string	否	模板所属资源栈或资源栈组的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。仅在指定 StackId、ChangeSetId 或 StackGroupName 时生效。	cn-hangzhou
TemplateId	string	否	模板 ID。支持共享模板和私有模板。您仅能指定 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、StackGroupName 其中一个参数。	5ecd1e10-b0e9-4389-a565-e4c15efc****
TemplateURL	string	否	包含模板主体的文件的位置。URL 必须指向位于 Web 服务器（HTTP 或 HTTPS）或阿里云 OSS 存储空间（例如：oss://ros/template/demo、oss://ros/template/demo?RegionId=cn-hangzhou）中的模板，模板最大为 524,288 个字节。说明如果 OSS 地域未指定，默认与接口参数 RegionId 相同。您必须且仅能指定 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、StackGroupName 其中一个参数。 URL 的最大长度为：1024 个字节。	oss://ros/template/demo
ChangeSetId	string	否	更改集 ID。您必须且仅能指定 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、StackGroupName 其中一个参数。	1f6521a4-05af-4975-afe9-bc4b45ad****
TemplateVersion	string	否	模板版本。当您设置 TemplateId 参数时，本参数生效。	v1
StackGroupName	string	否	资源栈组名称。您必须且仅能指定 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、StackGroupName 其中一个参数。	my-stack-group
Parameters	array<object>	否	模板中已定义的参数。
	object	否
ParameterKey	string	否	模板中已定义的参数的名称。如果您未指定参数的名称和值时，ROS 将使用模板中指定的默认值。 N 最大值为 200。说明 Parameters 为可选参数。如果需要指定 Parameters，则 Parameters.N.ParameterKey 和 Parameters.N.ParameterValue 必须同时指定。	InstanceId
ParameterValue	string	否	模板中已定义的参数的取值。 N 最大值为 200。说明 Parameters 为可选参数。如果需要指定 Parameters，则 Parameters.N.ParameterKey 和 Parameters.N.ParameterValue 必须同时指定。	i-rotp2e20whfrs2****
ClientToken	string	否	保证请求的幂等性。该参数值由客户端生成，并且必须全局唯一。长度不超过 64 个字符。可包含英文字母、数字、短划线（-）和下划线（_）。更多信息，请参见如何保证幂等性。	123e4567-e89b-12d3-a456-42665544****

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

返回参数

名称	类型	描述	示例值
	object
ResourceTypes	array	模板中用到的所有资源类型。
	string	模板中用到的所有资源类型。	["ALIYUN::ECS::VPC"]
Description	string	资源栈模板的描述信息。	No description
Parameters	array<object>	参数声明的列表。
	object	参数声明的列表。	[{"Description":"", "Label":"Name", "NoEcho":"false", "ParameterKey":"Name", "Type":"String"}]
RequestId	string	请求 ID。	B288A0BE-D927-4888-B0F7-B35EF84B6E6
Version	string	模板版本。	2015-09-01
Metadata	object	模板中定义的元数据。	{"key": "value"}
ResourceIdentifierSummaries	array<object>	资源标识符摘要的列表。摘要描述了导入操作的目标资源以及在导入过程中用于标识目标资源的属性。例如：VpcId 是 ALIYUN::ECS::VPC 资源的标识符属性。
	object
ResourceType	string	资源类型。说明该资源类型支持资源导入。	ALIYUN::ECS::VPC
LogicalResourceIds	array	模板中类型为 ResourceType 的所有资源的逻辑 ID。
	string	模板中类型为 ResourceType 的所有资源的逻辑 ID。	["Vpc"]
ResourceIdentifiers	array	资源属性。用来标识目标资源。例如：VpcId 是 ALIYUN::ECS::VPC 资源的标识符属性。
	string	资源属性。用来标识目标资源。例如：VpcId 是 ALIYUN::ECS::VPC 资源的标识符属性。	["VpcId"]

示例

正常返回示例

JSON格式

{
  "ResourceTypes": [
    "[\"ALIYUN::ECS::VPC\"]"
  ],
  "Description": "No description",
  "Parameters": [
    [
      {
        "Description": "",
        "Label": "Name",
        "NoEcho": "false",
        "ParameterKey": "Name",
        "Type": "String"
      }
    ]
  ],
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6",
  "Version": "2015-09-01",
  "Metadata": {
    "key": "value"
  },
  "ResourceIdentifierSummaries": [
    {
      "ResourceType": "ALIYUN::ECS::VPC",
      "LogicalResourceIds": [
        "[\"Vpc\"]"
      ],
      "ResourceIdentifiers": [
        "[\"VpcId\"]"
      ]
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史

HttpCode	错误码	错误信息	描述
400	StackValidationFailed	{reason}.	资源栈校验失败。reason 为具体原因。
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 Tempalte ({ ID }) could not be found.	模板不存在。ID 为模板 ID。
404	TemplateNotFound	The Template { ID } with version { version } could not be found.	模板或指定版本不存在。ID 为模板 ID，version 为模板版本。