GetTemplateSummary_资源编排_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

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

授权信息

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

具体说明如下:展开详情

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

请求参数

字段名称字段详情
StackIdstring

资源栈 ID。展开详情

示例值:4a6c9851-3b0f-4f5f-b4ca-a14bf691****参考取值来源:
    UpdateStack
    ListStacks
    CreateStack
    GetStackInstance
TemplateBodystring

模板的结构。长度为 1~524,288 个字节。 展开详情

示例值:{"ROSTemplateFormatVersion":"2015-09-01"}参考取值来源:
    GetTemplate
    UpdateStackTemplateByResources
    GenerateTemplateByScratch
RegionIdstring

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

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
TemplateIdstring

模板 ID。支持共享模板和私有模板。展开详情

示例值:5ecd1e10-b0e9-4389-a565-e4c15efc****参考取值来源:
    GetTemplate
    UpdateTemplate
    ListTemplates
    CreateTemplate
TemplateURLstring

包含模板主体的文件的位置。URL 必须指向位于 Web 服务器(HTTP 或 HTTPS)或阿里云 OSS 存储空间(例如:oss://ros/template/demo、oss://ros/template/demo?RegionId=cn-hangzhou)中的模板,模板最大为 524,288 个字节。 展开详情

示例值:oss://ros/template/demo
ChangeSetIdstring

更改集 ID。展开详情

示例值:1f6521a4-05af-4975-afe9-bc4b45ad****参考取值来源:
    ListChangeSets
    CreateChangeSet
TemplateVersionstring

模板版本。当您设置 TemplateId 参数时,本参数生效。

示例值:v1参考取值来源:
    ListTemplateVersions
    GetTemplate
    UpdateTemplate
StackGroupNamestring

资源栈组名称。展开详情

示例值:my-stack-group参考取值来源:
    GetStackGroup
    CreateStackGroup
    ListStackGroups
    ImportStacksToStackGroup
Parametersarray<object>

模板中已定义的参数。

子级条数 <= 200
ClientTokenstring

保证请求的幂等性。该参数值由客户端生成,并且必须全局唯一。 展开详情

示例值:123e4567-e89b-12d3-a456-42665544****

请求说明

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

返回参数

字段名称字段详情
ResourceTypesarray<string>

模板中用到的所有资源类型。

Descriptionstring

资源栈模板的描述信息。

示例值:No description
Parametersarray<object>

参数声明的列表。

RequestIdstring

请求 ID。

示例值:B288A0BE-D927-4888-B0F7-B35EF84B6E6
Versionstring

模板版本。

示例值:2015-09-01
Metadataobject

模板中定义的元数据。

示例值:{"key": "value"}
ResourceIdentifierSummariesarray<object>

资源标识符摘要的列表。 展开详情

返回示例

变更历史

变更时间变更内容概要操作
2022-07-21
新增请求参数Parameters

相关示例

调用GetTemplateSummary接口获取新模板或者现有模板的信息。
2022-09-19