使用资源编排模板创建资源栈,完成一组资源的创建。
接口说明
资源栈是针对ROS资源的管理单元,您可通过创建资源栈来创建一组资源。关于资源栈的更多信息,请参见概览。
使用限制:
- 每个阿里云账号最多创建200个资源栈。
- 每个资源栈中最多创建200个资源。
本文将提供一个示例,在杭州地域创建一个名为MyStack
的资源栈,并将资源栈的模板TemplateBody
设置为{"ROSTemplateFormatVersion":"2015-09-01"}
。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ros:CreateStack | WRITE |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DisableRollback | boolean | 否 | 当创建资源栈失败时,是否禁用回滚。 取值:
| false |
TemplateBody | string | 否 | 模板主体的结构。长度为1~524,288个字节。如果长度较长,则建议通过HTTP POST+Body Param的方式,将参数放在请求体中进行传递,避免因URL过长而导致请求失败。 说明您必须且仅能指定TemplateBody、TemplateURL、TemplateId或TemplateScratchId其中一个参数。 | {"ROSTemplateFormatVersion":"2015-09-01"} |
StackPolicyURL | string | 否 | 包含资源栈策略的文件的位置。URL必须指向位于Web服务器(HTTP或HTTPS)或阿里云OSS存储空间(例如:oss://ros/stack-policy/demo、oss://ros/stack-policy/demo?RegionId=cn-hangzhou)中的策略,策略文件最大长度为16,384个字节。如未指定OSS地域,默认与接口参数RegionId相同。 说明您仅能指定StackPolicyBody或StackPolicyURL其中一个参数。 URL最大长度为1350个字节。 | oss://ros-stack-policy/demo |
TimeoutInMinutes | long | 否 | 创建资源栈的超时时间。
| 10 |
StackPolicyBody | string | 否 | 包含资源栈策略主体的结构,长度为1~16,384个字节。 说明您仅能指定StackPolicyBody或StackPolicyURL其中一个参数。 | {"Statement": [{"Action": "Update:*", "Resource": "*", "Effect": "Allow", "Principal": "*"}]} |
StackName | string | 是 | 资源栈名称。 | MyStack |
RegionId | string | 是 | 资源栈所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。 | cn-hangzhou |
ClientToken | string | 否 | 保证请求的幂等性。该值由客户端生成,并且必须是全局唯一的。长度不超过64个字符,可包含英文字母、数字、短划线(-)和下划线(_)。 更多信息,请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-42665544**** |
TemplateURL | string | 否 | 包含模板主体的文件的位置。URL必须指向位于Web服务器(HTTP或HTTPS)或阿里云OSS存储空间(例如:oss://ros/stack-policy/demo、oss://ros/stack-policy/demo?RegionId=cn-hangzhou)中的模板,模板的最大长度为524,288个字节。如未指定OSS地域,默认与RegionId取值相同。 说明您必须且仅能指定TemplateBody、TemplateURL、TemplateId或TemplateScratchId其中一个参数。 | oss://ros-template/demo |
RamRoleName | string | 否 | RAM角色名称。ROS会扮演该角色创建资源栈,使用角色的凭证代表用户进行接口调用。 如果用户未指定该值,ROS将使用以前与资源栈关联的角色。如果没有可用角色,ROS将使用从您的用户凭证中生成的临时凭证。 RAM角色名称最大长度为64个字符。 | test-role |
DeletionProtection | string | 否 | 是否开启资源栈删除保护。取值:
说明嵌套资源栈删除保护与根资源栈一致。 | Enabled |
CreateOption | string | 否 | 创建选项,用于控制创建资源栈的行为。取值:
说明仅能指定CreateOption和CreateOptions其中一个参数。 | KeepStackOnCreationComplete |
CreateOptions | array | 否 | 创建选项列表。 | |
string | 否 | 创建选项,用于控制创建资源栈的行为。取值:
说明 | KeepStackOnCreationComplete | |
TemplateId | string | 否 | 模板ID。支持共享模板和私有模板。 说明您必须且仅能指定TemplateBody、TemplateURL、TemplateId或TemplateScratchId其中一个参数。 | 5ecd1e10-b0e9-4389-a565-e4c15efc**** |
TemplateVersion | string | 否 | 模板版本。仅在指定TemplateId时生效。 | v1 |
Parameters | array | 否 | 模板中已定义的参数。 | |
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-xxxxxx |
NotificationURLs | array | 否 | 接收资源栈事件的回调地址。取值:
每个URL最大长度为1024个字节。
资源栈状态变更会通知到事件总线(EventBridge)服务。您可以在事件总线控制台查看事件信息。 说明当前支持华东1(杭州)、华东2(上海)、华北2(北京)、中国(香港)、华北3(张家口)五个地域。 N最大值为5。资源栈的状态发生变化时,会进行通知。当资源栈启用回滚时,CREATE_FAILED(创建失败)和UPDATE_FAILED(更新失败)不会通知,而CREATE_ROLLBACK(创建失败回滚)和ROLLBACK(更新失败回滚)会进行通知。IN_PROGRESS状态不会通知。
| |
string | 否 | 接收资源栈事件的回调地址。取值:
每个URL最大长度为1024个字节。
资源栈状态变更会通知到事件总线(EventBridge)服务。您可以在事件总线控制台查看事件信息。 说明当前支持华东1(杭州)、华东2(上海)、华北2(北京)、中国(香港)、华北3(张家口)五个地域。 N最大值为5。资源栈的状态发生变化时,会进行通知。当资源栈启用回滚时,CREATE_FAILED(创建失败)和UPDATE_FAILED(更新失败)不会通知,而CREATE_ROLLBACK(创建失败回滚)和ROLLBACK(更新失败回滚)会进行通知。IN_PROGRESS状态不会通知。
| http://example.com/ros-event | |
Tags | array | 否 | 资源栈的标签。 | |
object | 否 | |||
Key | string | 是 | usage | |
Value | string | 否 | test | |
ResourceGroupId | string | 否 | 资源组ID。如果不指定该参数,资源栈将加入默认资源组。 关于资源组的更多信息,请参见什么是资源组。 | rg-acfmxazb4ph6aiy**** |
Parallelism | long | 否 | 资源最大并发数。 默认为空,用户可以输入大于等于零的整数。 说明 | 1 |
TemplateScratchId | string | 否 | 资源场景ID。 关于如何获取资源场景ID,请参见ListTemplateScratches。 说明您必须且仅能指定TemplateBody、TemplateURL、TemplateId或TemplateScratchId其中一个参数。 | ts-aa9c62feab844a6b**** |
TemplateScratchRegionId | string | 否 | 资源场景所属的地域ID,默认与RegionId取值相同。 您可以调用DescribeRegions查看最新的阿里云地域列表。 | cn-hangzhou |
关于公共请求参数的详情,请参见公共参数。
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F",
"StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2023-04-13 | OpenAPI 入参发生变更 | |||||
|
错误代码 | 错误信息 | HTTPS状态码 | 描述 |
---|---|---|---|
CircularDependency | Circular Dependency Found: {reason}. | 400 | 模板包含循环引用,reason为具体原因。 |
InvalidSchema | {reason}. | 400 | 模板格式不正确,reason为具体原因。 |
InvalidTemplateAttribute | The Referenced Attribute ({resource} {name}) is incorrect. | 400 | 模板包含不正确的资源属性(输出)引用,resource为资源名,name为属性名。 |
InvalidTemplatePropertyType | The specified value type of ({resource} {section}) is incorrect. | 400 | 模板字段中定义的资源属性类型不正确。resource为资源名,section为字段名。 |
InvalidTemplateReference | The specified reference "{name}" (in {referencer}) is incorrect. | 400 | 模板包含不正确的引用,name为引用名,referencer为引用者。 |
InvalidTemplateSection | The template section is invalid: {section}. | 400 | 模板包含无效的字段,section为字段名。 |
InvalidTemplateVersion | The template version is invalid: {reason}. | 400 | 模板版本不正确,reason为具体原因。 |
StackValidationFailed | {reason}. | 400 | 资源栈校验失败,reason为具体原因。 |
UnknownUserParameter | The Parameter ({name}) was not defined in template. | 400 | 传递的参数在模板中未定义,name为参数名。 |
UserParameterMissing | The Parameter {name} was not provided. | 400 | 参数在模板中已定义,但未传递值,name为参数名。 |
ActionInProgress | Stack {name} already has an action ({action}) in progress. | 409 | 资源栈在变更中,name为资源栈名称或ID,action为变更操作。 |
StackExists | The Stack ({name}) already exists. | 409 | 同名资源栈已存在,name为资源栈名称。 |
TemplateNotFound | The Template ({ ID }) could not be found. | 404 | 模板不存在。ID为模板ID。 |
TemplateNotFound | The Template { ID } with version { version } could not be found. | 404 | 模板或指定版本不存在。ID为模板ID,version为模板版本。 |