接口说明
本文将提供一个示例，在杭州地域创建并预览一个名为MyStack的资源栈，该资源栈的模板TemplateBody设置为{"ROSTemplateFormatVersion":"2015-09-01"}。
流控信息
请求参数
| 字段名称 | 字段详情 |
|---|---|
DisableRollbackboolean | 当创建资源栈失败时，是否禁用回滚。取值：展开详情 示例值:false |
TimeoutInMinutesinteger<int64> | |
TemplateBodystring | 模板主体的结构。长度为 1~524,288 个字节。如果长度较长，则建议通过 HTTP POST+Body Param 的方式，将参数放在请求体中进行传递，避免因 URL 过长而导致请求失败。 展开详情 示例值:{"ROSTemplateFormatVersion":"2015-09-01"}参考取值来源: GetTemplate UpdateStackTemplateByResources GenerateTemplateByScratch |
StackPolicyURLstring | 包含资源栈策略的文件的位置。URL 必须指向位于 Web 服务器（HTTP 或 HTTPS）或阿里云 OSS 存储空间（例如：oss://ros/stack-policy/demo、oss://ros/stack-policy/demo?RegionId=cn-hangzhou）中的策略，策略文件最大长度为 16,384 个字节。如未指定 OSS 地域，默认与 RegionId 取值相同。 展开详情 示例值:oss://ros-stack-policy/demo |
RegionIdstring | 资源栈所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 示例值:cn-hangzhou参考取值来源: DescribeRegions |
StackPolicyBodystring | 包含资源栈策略主体的结构，长度为 1~16,384 个字节。 展开详情 示例值:{"Statement": [{"Action": "Update:*", "Resource": "*", "Effect": "Allow", "Principal": "*"}]}参考取值来源: GetStackPolicy |
StackNamestring | 资源栈名称。预览创建资源栈。展开详情 示例值:MyStack参考取值来源: GetStack CreateStack ListStacks |
ClientTokenstring | 保证请求的幂等性。该值由客户端生成，并且必须是全局唯一的。 展开详情 示例值:123e4567-e89b-12d3-a456-42665544**** |
TemplateURLstring | 包含模板主体的文件的位置。URL 必须指向位于 Web 服务器（HTTP 或 HTTPS）或阿里云 OSS 存储空间（例如：oss://ros/stack-policy/demo、oss://ros/stack-policy/demo?RegionId=cn-hangzhou）中的模板，模板的最大长度为 524,288 个字节。如未指定 OSS 地域，默认与 RegionId 取值相同。 展开详情 示例值:oss://ros-template/demo |
TemplateIdstring | 模板 ID。支持共享模板和私有模板。展开详情 示例值:5ecd1e10-b0e9-4389-a565-e4c15efc****参考取值来源: GetTemplate UpdateTemplate ListTemplates CreateTemplate |
TemplateVersionstring | 模板版本。仅在指定 TemplateId 时生效。 示例值:v1参考取值来源: ListTemplateVersions GetTemplate UpdateTemplate |
Parametersarray<object> | 参数。 子级条数 <= 200 |
Parallelisminteger<int64> | 资源最大并发数。仅对 Terraform 类型资源栈生效。展开详情 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:1 |
TemplateScratchIdstring | 资源场景 ID。展开详情 示例值:ts-aa9c62feab844a6b****参考取值来源: UpdateTemplateScratch CreateTemplateScratch ListTemplateScratches |
TemplateScratchRegionIdstring | 资源场景所属的地域 ID，默认与 RegionId 取值相同。展开详情 示例值:cn-hangzhou |
StackIdstring | 资源栈 ID。预览更新资源栈。展开详情 示例值:4a6c9851-3b0f-4f5f-b4ca-a14bf691****参考取值来源: UpdateStack ListStacks CreateStack GetStackInstance |
EnablePreConfigboolean | 是否获取合规预检参数。展开详情 示例值:false |
请求说明
关于公共请求参数的详情，请参见公共参数。
返回参数
| 字段名称 | 字段详情 |
|---|---|
RequestIdstring | 请求 ID。 示例值:B288A0BE-D927-4888-B0F7-B35EF84B6E6F |
Stackobject | 资源栈预览数据。 |