接口说明
资源栈是针对 ROS 资源的管理单元,您可通过创建资源栈来创建一组资源。关于资源栈的更多信息,请参见概览。
使用限制:
- 每个阿里云账号最多创建 200 个资源栈。
- 每个资源栈中最多创建 200 个资源。
本文将提供一个示例,在杭州地域创建一个名为MyStack
的资源栈,并将资源栈的模板TemplateBody
设置为{"ROSTemplateFormatVersion":"2015-09-01"}
。
流控信息
请求参数
字段名称 | 字段详情 |
---|---|
DisableRollbackboolean | 当创建资源栈失败时,是否禁用回滚。展开详情 示例值:false |
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 |
TimeoutInMinutesinteger<int64> | |
StackPolicyBodystring | 包含资源栈策略主体的结构,长度为 1~16,384 个字节。展开详情 示例值:{"Statement": [{"Action": "Update:*", "Resource": "*", "Effect": "Allow", "Principal": "*"}]}参考取值来源: GetStackPolicy PreviewStack |
StackNamestring | 资源栈名称。 展开详情 示例值:MyStack参考取值来源: GetStack PreviewStack ListStacks |
RegionIdstring | 资源栈所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 示例值:cn-hangzhou参考取值来源: DescribeRegions |
ClientTokenstring | 保证请求的幂等性。该值由客户端生成,并且必须是全局唯一的。长度不超过 64 个字符,可包含英文字母、数字、短划线(-)和下划线(_)。 展开详情 示例值: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 |
RamRoleNamestring | RAM 角色名称。ROS 会扮演该角色创建资源栈,使用角色的凭证代表用户进行接口调用。 展开详情 示例值:test-role |
DeletionProtectionstring | 是否开启资源栈删除保护。取值:展开详情 示例值:Enabled |
CreateOptionstring | 创建选项,用于控制创建资源栈的行为。取值:展开详情 示例值:KeepStackOnCreationComplete |
CreateOptionsarray<string> | 创建选项列表。 子级条数 <= 2 |
TemplateIdstring | 模板 ID。支持共享模板和私有模板。展开详情 示例值:5ecd1e10-b0e9-4389-a565-e4c15efc****参考取值来源: GetTemplate UpdateTemplate ListTemplates CreateTemplate |
TemplateVersionstring | 模板版本。仅在指定 TemplateId 时生效。 示例值:v1参考取值来源: ListTemplateVersions GetTemplate UpdateTemplate |
Parametersarray<object> | 模板中已定义的参数。 子级条数 <= 200 |
NotificationURLsarray<string> | 接收资源栈事件的回调地址。取值:展开详情 示例值:http://my-site.com/ros-event子级条数 <= 5 |
Tagsarray<object> | 资源栈的标签。 子级条数 <= 20 |
ResourceGroupIdstring | 资源组 ID。如果不指定该参数,资源栈将加入默认资源组。 展开详情 示例值:rg-acfmxazb4ph6aiy****参考取值来源: GetStackGroup ListStackGroups |
Parallelisminteger<int64> | |
TemplateScratchIdstring | 资源场景 ID。展开详情 示例值:ts-aa9c62feab844a6b****参考取值来源: UpdateTemplateScratch ListTemplateScratches CreateTemplateScratch |
TemplateScratchRegionIdstring | 资源场景所属的地域 ID,默认与 RegionId 取值相同。展开详情 示例值:cn-hangzhou |
请求说明
关于公共请求参数的详情,请参见公共参数。
返回参数
字段名称 | 字段详情 |
---|---|
RequestIdstring | 请求 ID。 示例值:B288A0BE-D927-4888-B0F7-B35EF84B6E6F |
StackIdstring | 资源栈 ID。 示例值:4a6c9851-3b0f-4f5f-b4ca-a14bf691**** |