為資源棧創建更改集,您可以在執行更改之前查看對應更改內容。
接口說明
使用場景
使用更改集創建資源棧
如果您想管理大量的云資源,并在資源棧創建成功之前預覽資源的創建效果,您可以選擇使用更改集創建資源棧。此時您需要將ChangeSetType
參數設置為 CREATE 并完成相關參數配置。關于更改集的更多信息,請參見更改集。
使用更改集更新資源棧
如果您想在更新資源之前預覽該操作對資源棧的影響,您可以選擇為現有資源棧創建更改集。此時您需要將 ChangeSetType 參數設置為 UPDATE 并完成相關參數配置。 關于更改集的更多信息,請參見更改集。
使用現有資源創建資源棧
如果您需要將現有的云資源添加到一個新的資源棧中進行統一管理,您可以選擇使用更改集創建資源棧并完成資源導入。此時您需要將 ChangeSetType 參數設置為 IMPORT 并完成相關參數配置。關于資源導入的更多信息,請參見概覽。
將現有資源導入資源棧
如果您想要將現有資源導入到一個已有資源棧中進行統一管理,您可以選擇使用更改集對已有資源棧進行更新。此時您需要將 ChangeSetType 參數設置為 IMPORT 并完成相關參數配置。關于資源導入的更多信息,請參見概覽。
使用限制
- 只有部分狀態下的資源棧支持通過更改集更新。更多信息,請參見通過更改集更新資源棧。
- 一個資源棧最多同時存在 20 個更改集。
- 更改集只顯示資源棧變化,不顯示資源棧是否成功更新。
- 更改集不檢查是否將超出賬號限制、是否將更新不支持更新的資源、是否權限不足而無法修改資源,所有這些都將導致資源棧更新失敗。如果更新失敗,ROS 將嘗試將您的資源回滾到原始狀態。
本文以使用更改集更新資源棧為例,在杭州地域cn-hangzhou
創建一個名為MyChangeSet
的更改集,將 ID 為4a6c9851-3b0f-4f5f-b4ca-a14bf691****
的資源棧的模板更新為{"ROSTemplateFormatVersion":"2015-09-01"}
。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ros:CreateChangeSet | create |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
StackId | string | 否 | 創建更改集的資源棧的 ID。ROS 通過將此資源棧的信息與您提交的信息(例如:修改后的模板或不同的參數輸入值)進行比較來生成更改集。 說明
該參數僅在更改集類型為 UPDATE 或 IMPORT 時生效。
| 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** |
StackPolicyURL | string | 否 | 包含資源棧策略的文件的位置。URL 必須指向位于 Web 服務器(HTTP 或 HTTPS)或阿里云 OSS 存儲空間(例如:oss://ros/stack-policy/demo、oss://ros/stack-policy/demo?RegionId=cn-hangzhou)的策略,策略文件長為 16384 個字節。 URL 的最大長度為 1350 個字節。 說明
OSS 地域如未指定,默認與接口參數 RegionId 相同。
當更改集類型為 CREATE 時,您僅能指定 StackPolicyBody 或 StackPolicyURL 參數之一。 當更改集類型為 UPDATE 時,您僅能指定以下參數之一:
| oss://ros/stack-policy/demo |
StackPolicyBody | string | 否 | 資源棧策略的結構,長度為 1~16,384 個字節。 當更改集類型為 CREATE 時,您僅能指定 StackPolicyBody 或 StackPolicyURL 其中一個參數。 當更改集類型為 UPDATE 時,您僅能指定以下參數之一:
| {"Statement":[{"Effect":"Allow","Action":"Update:*","Principal":"*","Resource":"*"}]} |
StackName | string | 否 | 創建更改集的資源棧的名稱。 說明
該參數僅在更改集類型為 CREATE 或 IMPORT 時生效。
| MyStack |
UsePreviousParameters | boolean | 否 | 對于未傳遞的參數,是否使用上次傳遞的值。取值:
說明
該參數僅在更改集類型為 UPDATE 或 IMPORT 時生效。
| true |
ChangeSetType | string | 否 | 更改集的類型。取值:
當您選擇更改集類型為 CREATE 時,ROS 會為您創建新的資源棧。此時資源棧將處于 說明
| UPDATE |
Description | string | 否 | 更改集的描述。最大長度為 1024 個字節。 | It is a demo. |
RegionId | string | 是 | 更改集所屬的地域 ID。 您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
ClientToken | string | 否 | 保證請求的冪等性。該參數值由客戶端生成,并且必須全局唯一。 | 123e4567-e89b-12d3-a456-42665544**** |
TemplateURL | string | 否 | 包含模板主體的文件的位置。URL 必須指向位于 Web 服務器(HTTP 或 HTTPS)或阿里云 OSS 存儲空間(例如:oss://ros/template/demo、oss://ros/template/demo?RegionId=cn-hangzhou)中的模板,模板最大值為 524,288 個字節。 說明
如果 OSS 地域未指定,默認與接口參數 RegionId 相同。
您僅能指定 TemplateBody、TemplateURL 或 TemplateId 其中一個參數。 URL 最大長度為 1024 個字節。 | oss://ros/template/demo |
StackPolicyDuringUpdateURL | string | 否 | 更新資源棧策略的文件的位置。URL 必須指向位于 Web 服務器(HTTP 或 HTTPS)或阿里云 OSS 存儲空間(例如:oss://ros/stack-policy/demo、oss://ros/stack-policy/demo?RegionId=cn-hangzhou)中的策略,策略文件最長為 16,384 個字節。 說明
OSS 地域如未指定,默認與接口參數 RegionId 相同。
URL 最大長度為 1350 個字節。
| oss://ros/stack-policy/demo |
TemplateBody | string | 否 | 模板主體的結構。長度為 1~524,288 個字節。如果長度較大,則建議通過 HTTP POST+Body Param 的方式,將參數放在請求體中進行傳遞,避免因 URL 過長而導致請求失敗。 說明
您必須且僅能指定 TemplateBody、TemplateURL 或 TemplateId 其中一個參數。
| {"ROSTemplateFormatVersion":"2015-09-01"} |
TimeoutInMinutes | long | 否 | 資源棧狀態變為 CREATE_FAILED 或 UPDATE_FAILED 之前可以經過的時間量。
| 12 |
DisableRollback | boolean | 否 | 當創建資源棧失敗時,是否禁用回滾策略。
說明
該參數僅在更改集類型為 CREATE 或 IMPORT 時生效。
| false |
ChangeSetName | string | 是 | 更改集的名稱。 說明
更改集名稱在與指定資源棧關聯的所有更改集中必須是唯一的。
| MyChangeSet |
StackPolicyDuringUpdateBody | string | 否 | 臨時覆蓋資源棧策略的結構。長度為 1~16,384 個字節。
| {"Statement":[{"Effect":"Allow","Action":"Update:*","Principal":"*","Resource":"*"}]} |
RamRoleName | string | 否 | RAM 角色名稱。ROS 會扮演該角色創建資源棧,使用角色的憑證代表用戶進行接口調用。 RAM 角色的更多信息,請參見資源棧角色。 | test-role |
ReplacementOption | string | 否 | 如果資源的屬性發生了變化,且變化的屬性不支持修改更新(資源物理 ID 不變),是否使用替換更新(刪除資源,重新創建,資源物理 ID 會發生變化)。取值:
說明
修改更新的優先級高于替換更新。該參數僅在更改集類型為 UPDATE 時生效。
| Disabled |
TemplateId | string | 否 | 模板 ID。支持共享模板和私有模板。 您可以通過調用ListTemplates - 查詢模板列表接口查看模板 ID。 說明
您僅能指定 TemplateBody、TemplateURL 或 TemplateId 其中一個參數。
| 5ecd1e10-b0e9-4389-a565-e4c15efc**** |
TemplateVersion | string | 否 | 模板版本。 說明
該參數僅在指定 TemplateId 時生效。
| v1 |
Parameters | array<object> | 否 | 模板中已定義的參數。 | |
object | 否 | |||
ParameterKey | string | 是 | 模板中已定義的參數的名稱。如果未指定特定參數的名稱和取值,則 ROS 將使用模板中指定的默認值。N 的最大值為 200。 說明
Parameters 為可選參數。若指定了 Parameters,則 Parameters.N.ParameterKey 為必選參數。
| Amount |
ParameterValue | string | 是 | 模板中已定義的參數的取值。N 的最大值為 200。 說明
Parameters 為可選參數。若指定了 Parameters,則 Parameters.N.ParameterValue 為必選參數。
| 12 |
NotificationURLs | array | 否 | 接收資源棧事件的回調地址列表。 | |
string | 否 | 接收資源棧事件的回調地址。取值:
說明
當前支持華東 1(杭州)、華東 2(上海)、華北 2(北京)、中國(香港)、華北 3(張家口)五個地域。
N 最大值為 5。資源棧的狀態發生變化時,會進行通知。當資源棧啟用回滾時,CREATE_FAILED(創建失敗)和 UPDATE_FAILED(更新失敗)不會通知,而 CREATE_ROLLBACK(創建失敗回滾)和 ROLLBACK(更新失敗回滾)會進行通知。IN_PROGRESS 狀態不會通知。
| http://example.com/ros-notify | |
ResourcesToImport | array<object> | 否 | 待導入資源列表。 | |
object | 否 | |||
ResourceIdentifier | string | 否 | 字符串到字符串的鍵值映射。取值是 JSON 格式的字符串,用來標識要導入的資源。 資源的標識符屬性可以通過 GetTemplateSummary 接口獲取。 說明
該參數僅在更改集類型為 IMPORT 時生效。ResourcesToImport 為可選參數。若指定了 ResourcesToImport,則 ResourcesToImport.N.ResourceIdentifier 為必選參數。
| {"VpcId": "vpc-2zevx9ios******"} |
LogicalResourceId | string | 否 | 資源邏輯 ID,即模板中資源的名稱。 說明
該參數僅在更改集類型為 IMPORT 時生效。ResourcesToImport 為可選參數。若指定了 ResourcesToImport,則 ResourcesToImport.N.LogicalResourceId 為必選參數。
| Vpc |
ResourceType | string | 否 | 資源的類型,需要與模板中定義的類型一致。 說明
該參數僅在更改集類型為 IMPORT 時生效。ResourcesToImport 為可選參數。若指定了 ResourcesToImport,則 ResourcesToImport.N.ResourceType 為必選參數。
| ALIYUN::ECS::VPC |
TemplateScratchId | string | 否 | 資源場景 ID,即資源納管場景 ID。 當 ChangeSetType 取值為 IMPORT 時,該參數才有效,該參數僅支持創建新的資源棧導入。 如果您想通過資源納管場景導入資源時,請只設置該參數,而不是模板相關參數。 您可以通過調用ListTemplateScratches - 查詢資源場景列表查看資源納管場景 ID。 | 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** |
Parallelism | long | 否 | 資源最大并發數。默認為空,用戶可以輸入大于等于零的整數。設置資源最大并發數后,將與資源棧進行關聯,影響資源棧的后續操作。 該參數僅在更改集類型為 CREATE 或 UPDATE 時生效,取值:
| 1 |
關于公共請求參數的詳情,請參見公共參數。
返回參數
示例
正常返回示例
JSON
格式
{
"ChangeSetId": "e85abe0c-6528-43fb-ae93-fdf8de22****",
"RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F",
"StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-01-11 | API 內部配置變更,不影響調用 | 查看變更詳情 |
2023-08-15 | API 內部配置變更,不影響調用 | 查看變更詳情 |
HttpCode | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | CircularDependency | Circular Dependency Found: {reason}. | 模板包含循環引用。reason 為具體原因。 |
400 | InvalidSchema | {reason}. | 模板格式不正確。reason 為具體原因。 |
400 | InvalidTemplateAttribute | The Referenced Attribute ({resource} {name}) is incorrect. | 模板包含不正確的資源屬性(輸出)引用。resource 為資源名,name 為屬性名。 |
400 | InvalidTemplatePropertyType | The specified value type of ({resource} {section}) is incorrect. | 模板資源定義中的字段類型不正確。resource 為資源名,section 為字段名。 |
400 | InvalidTemplateReference | The specified reference "{name}" (in {referencer}) is incorrect. | 模板包含不正確的引用。name 為引用名,referencer 為引用者。 |
400 | InvalidTemplateSection | The template section is invalid: {section}. | 模板包含無效的字段。section 為字段名。 |
400 | InvalidTemplateVersion | The template version is invalid: {reason}. | 模板版本不正確。reason 為具體原因。 |
400 | StackPolicyValidationFailed | Action denied by stack policy: {reason}. | 未通過資源棧策略校驗。reason 為具體原因。 |
400 | StackValidationFailed | {reason}. | 資源棧校驗失敗。reason 為具體原因。 |
400 | UnknownUserParameter | The Parameter ({name}) was not defined in template. | 傳遞的參數在模板中未定義。name 為參數名。 |
400 | UserParameterMissing | The Parameter {name} was not provided. | 參數在模板中已定義,但未傳遞值。name 為參數名。 |
404 | StackNotFound | The Stack ({name}) could not be found. | 資源棧不存在。name 為資源棧名稱或 ID。 |
409 | ActionInProgress | Stack {name} already has an action ({action}) in progress. | 資源棧在變更中。name 為資源棧名稱或 ID,action 為具體的變更操作。 |
409 | ChangeSetExists | The ChangeSet ({name}) of Stack ({stack}) already exists. | 同名更改集已存在。name 為更改集名,stack 為關聯的資源棧名稱或 ID。 |
409 | StackExists | The Stack ({name}) already exists. | 同名資源棧已存在。name 為資源棧名稱。 |
404 | TemplateNotFound | The Tempalte ({ ID }) could not be found. | 模板不存在。ID 為模板 ID。 |
404 | TemplateNotFound | The Template { ID } with version { version } could not be found. | 模板或指定版本不存在。ID 為模板 ID,version 為模板版本。 |