使用資源編排模板創建資源棧,完成一組資源的創建。
接口說明
資源棧是針對 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 | create | *Stack acs:ros:{#regionId}:{#accountId}:stack/* |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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> | 否 | 模板中已定義的參數。 | |
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 | 否 | 接收資源棧事件的回調地址。取值:
說明
當前支持華東 1(杭州)、華東 2(上海)、華北 2(北京)、中國(香港)、華北 3(張家口)五個地域。
N 最大值為 5。資源棧的狀態發生變化時,會進行通知。當資源棧啟用回滾時,CREATE_FAILED(創建失敗)和 UPDATE_FAILED(更新失敗)不會通知,而 CREATE_ROLLBACK(創建失敗回滾)和 ROLLBACK(更新失敗回滾)會進行通知。IN_PROGRESS 狀態不會通知。
| |
string | 否 | 接收資源棧事件的回調地址。取值:
說明
當前支持華東 1(杭州)、華東 2(上海)、華北 2(北京)、中國(香港)、華北 3(張家口)五個地域。
N 最大值為 5。資源棧的狀態發生變化時,會進行通知。當資源棧啟用回滾時,CREATE_FAILED(創建失敗)和 UPDATE_FAILED(更新失敗)不會通知,而 CREATE_ROLLBACK(創建失敗回滾)和 ROLLBACK(更新失敗回滾)會進行通知。IN_PROGRESS 狀態不會通知。
| http://example.com/ros-event | |
Tags | array<object> | 否 | 資源棧的標簽。 | |
object | 否 | |||
Key | string | 是 | 資源棧的標簽鍵。 N 的取值范圍為 1~20。 說明
| 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****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-01-11 | API 內部配置變更,不影響調用 | 查看變更詳情 |
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 為模板版本。 |