更新已建立的資源棧組。
介面說明
本文將提供一個樣本,將杭州地區已有的自助系統管理權限模式的資源棧組MyStackGroup的模板更新為{"ROSTemplateFormatVersion": "2015-09-01"}。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ros:UpdateStackGroup |
update |
*StackGroup
Template
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
資源棧組所屬的地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。 |
cn-hangzhou |
| StackGroupName |
string |
是 |
資源棧組名稱。名稱在單個地區內唯一。 |
MyStackGroup |
| Description |
string |
否 |
資源棧組描述。 長度為 1~256 個字元。 |
My Stack Group |
| AccountIds |
array |
否 |
使用自助系統管理權限模式部署資源棧的目標帳號 ID 列表。最多支援添加 50 個目標帳號 ID。 |
["12****"] |
|
string |
否 |
使用自助系統管理權限模式部署資源棧的目標帳號 ID 列表。最多支援添加 50 個目標帳號 ID。 |
["151266687691****","141261387191****"] |
|
| RegionIds |
array |
否 |
目標執行地區列表。最多支援添加 20 個地區。 |
["cn-hangzhou", "cn-beijing"] |
|
string |
否 |
目標執行地區列表。最多支援添加 20 個地區。 |
["cn-hangzhou","cn-beijing"] |
|
| TemplateBody |
string |
否 |
模板主體的結構。長度為 1~524,288 個位元組。如果長度較大,則建議通過 HTTP POST+Body Param 的方式,將參數放在請求體中進行傳遞,避免因 URL 過長而導致請求失敗。 說明
您必須且僅能指定 TemplateBody、TemplateURL 或 TemplateId 其中一個參數。 |
{"ROSTemplateFormatVersion": "2015-09-01"} |
| TemplateURL |
string |
否 |
包含模板主體的檔案的位置。URL 必須指向位於 HTTP Web 服務器(HTTP 或 HTTPS)或阿里雲 OSS 儲存桶中的模板(1~524,288 個位元組)。OSS 儲存桶的 URL,例如 oss://ros/template/demo 或 oss://ros/template/demo?RegionId=cn-hangzhou。如未指定 OSS 地區,預設與介面參數 RegionId 相同。 說明
您必須且僅能指定 TemplateBody、TemplateURL 或 TemplateId 其中一個參數。 |
oss://ros-template/demo |
| ClientToken |
string |
否 |
保證請求的等冪性。該值由用戶端產生,並且必須是全域唯一的。 |
123e4567-e89b-12d3-a456-42665544**** |
| OperationDescription |
string |
否 |
更新資源棧組的操作描述。 |
Update stack instances in hangzhou |
| OperationPreferences |
object |
否 |
更新資源棧組的操作設定。 包含以下參數:
多個參數之間用半形逗號(,)分隔。 說明
|
{"FailureToleranceCount": 1,"MaxConcurrentCount": 2} |
| AdministrationRoleName |
string |
否 |
建立具有自助系統管理權限的資源棧組時,需指定的供 ROS 扮演的 RAM 管理員角色名稱。若不指定,則使用 AliyunROSStackGroupAdministrationRole 作為預設值。ROS 以該角色身份進一步扮演執行角色(AliyunROSStackGroupExecutionRole)來操作資源棧組中資源棧執行個體所對應的資源棧。 長度為 1~64 個字元,可包含英文字母、數字和短劃線(-)。 |
AliyunROSStackGroupAdministrationRole |
| ExecutionRoleName |
string |
否 |
建立具有自助系統管理權限的資源棧組時,需指定的供管理員角色(AliyunROSStackGroupAdministrationRole)扮演的 RAM 執行角色名稱。若不指定,則使用 AliyunROSStackGroupExecutionRole 作為預設值。ROS 以該角色身份來操作資源棧組中資源棧執行個體所對應的資源棧。 長度為 1~64 個字元,可包含英文字母、數字和短劃線(-)。 |
AliyunROSStackGroupExecutionRole |
| TemplateId |
string |
否 |
模板 ID。支援共用模板和私人模板。 說明
您必須且僅能指定 TemplateBody、TemplateURL 或 TemplateId 其中一個參數。 |
5ecd1e10-b0e9-4389-a565-e4c15efc**** |
| TemplateVersion |
string |
否 |
模板版本。若不指定,預設取最新版本。 說明
TemplateVersion 僅在指定 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 為必選參數。 |
1 |
| PermissionModel |
string |
否 |
授權模式。 取值:
|
SELF_MANAGED |
| AutoDeployment |
object |
否 |
自動部署設定資訊。 說明
僅當 PermissionModel 為 SERVICE_MANAGED 時,需要指定該參數。 |
{"Enabled": true, "RetainStacksOnAccountRemoval": true} |
| Enabled |
boolean |
是 |
啟用或者禁用自動部署。 取值:
|
true |
| RetainStacksOnAccountRemoval |
boolean |
否 |
目標資源夾中刪除成員帳號時,是否保留成員帳號中的資源棧。 取值:
說明
當 Enabled 為 true 時,RetainStacksOnAccountRemoval 必選。 |
true |
| DeploymentTargets |
object |
否 |
使用服務系統管理權限模式更新資源棧的部署目標。 |
{"RdFolderIds": ["fd-4PvlVLOL8v"]} |
| RdFolderIds |
array |
否 |
資來源目錄的資源夾 ID 列表。 |
|
|
string |
否 |
資來源目錄的資源夾 ID 列表。最多支援添加 20 個資源夾 ID。 您需要至少指定 RdFolderIds 和 AccountIds 其中一個參數,具體如下:
說明
您可以在資源管理控制台的概覽頁面查看資源夾 ID。具體操作,請參見查看資源夾基本資料。 |
["fd-4PvlVLOL8v"] |
|
| AccountIds |
array |
否 |
資來源目錄中的成員帳號 ID 列表。最多支援添加 30 個成員帳號 ID。 說明
您可以在資源管理控制台的概覽頁面查看成員帳號 ID。具體操作,請參見查看成員詳情。 |
|
|
string |
否 |
資來源目錄中的成員帳號 ID 列表。最多支援添加 30 個成員帳號 ID。 說明
您可以在資源管理控制台的概覽頁面查看成員帳號 ID。具體操作,請參見查看成員詳情。 |
["151266687691****","141261387191****"] |
|
| Capabilities |
array |
否 |
資源棧組選項列表,最大長度為 1。 |
|
|
string |
否 |
源棧組選項。可選值:ExpandModules,在當前帳號展開模組。 說明
|
ExpandModules |
|
| DeploymentOptions |
array |
否 |
使用服務系統管理權限模式更新資源棧組的部署選項列表。最多支援 1 個部署選項。 |
|
|
string |
否 |
可選值:
|
關於公用請求參數的詳情,請參見公用參數。
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
14A07460-EBE7-47CA-9757-12CC4761D47A |
| OperationId |
string |
操作 ID。 |
6da106ca-1784-4a6f-a7e1-e723863d**** |
樣本
正常返回樣本
JSON格式
{
"RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
"OperationId": "6da106ca-1784-4a6f-a7e1-e723863d****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。