接口说明
使用说明
本文将提供一个示例,查询杭州地域模板{ "ROSTemplateFormatVersion": "2015-09-01", "Parameters": { "ZoneInfo": { "Type": "String" }, "InstanceType": { "Type": "String" } }, "Resources": { "ECS": { "Type": "ALIYUN::ECS::Instance", "Properties": { "ZoneId": { "Ref": "ZoneInfo" }, "InstanceType": { "Ref": "InstanceType" } } } } }
中参数ZoneInfo
的取值。
关于本接口支持查询的参数和模板内容,请参见参数约束查询。
流控信息
请求参数
字段名称 | 字段详情 |
---|---|
TemplateBodystring | 模板主体的结构。长度为 1~524,288 个字节。如果长度较长,则建议通过 HTTP POST+Body Param 的方式,将参数放在请求体中进行传递,避免因 URL 过长而导致请求失败。展开详情 示例值:{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"ZoneInfo": {
"Type": "String"
},
"InstanceType": {
"Type": "String"
}
},
"Resources": {
"ECS": {
"Type": "ALIYUN::ECS::Instance",
"Properties": {
"ZoneId": {
"Ref": "ZoneInfo"
},
"InstanceType": {
"Ref": "InstanceType"
}
}
}
}
}参考取值来源: GetTemplate UpdateStackTemplateByResources GenerateTemplateByScratch |
RegionIdstring | 地域 ID。 展开详情 示例值:cn-hangzhou参考取值来源: DescribeRegions |
TemplateURLstring | 包含模板主体的文件的位置。URL 必须指向位于 Web 服务器(HTTP 或 HTTPS)或阿里云 OSS 存储空间(例如:oss://ros/template/demo 或 oss://ros/template/demo?RegionId=cn-hangzhou)中的模板,模板的最大长度为 524,288 个字节。如未指定 OSS 地域,默认与接口参数 RegionId 相同。展开详情 示例值:oss://ros-template/demo |
TemplateIdstring | 模板 ID。支持共享模板和私有模板。 展开详情 示例值:5ecd1e10-b0e9-4389-a565-e4c15efc****参考取值来源: GetTemplate UpdateTemplate ListTemplates CreateTemplate |
TemplateVersionstring | 模板版本。如果不指定,默认取最新版本。 展开详情 示例值:v1参考取值来源: ListTemplateVersions GetTemplate UpdateTemplate |
Parametersarray<object> | 模板中已定义的参数。 子级条数 <= 200 |
ParametersKeyFilterarray<string> | 需要查询的参数列表。 子级条数 <= 200子级条数 >= 1 |
ClientTokenstring | 保证请求的幂等性。展开详情 示例值:123e4567-e89b-12d3-a456-42665544**** |
ParametersOrderarray<string> | 参数依赖关系。 子级条数 <= 100子级条数 >= 0 |
StackIdstring | 资源栈 ID。展开详情 示例值:c754d2a4-28f1-46df-b557-9586173a****参考取值来源: UpdateStack ListStacks CreateStack GetStackInstance |
返回参数
字段名称 | 字段详情 |
---|---|
RequestIdstring | 请求 ID。 示例值:9816785B-BCF8-514D-8B76-C1EC2BC954FC |
ParameterConstraintsarray<object> | 参数约束信息。 |