全部產品
Search
文件中心

Resource Orchestration Service:UpdateStackGroup - 更新資源棧組

更新時間:Dec 19, 2025

更新已建立的資源棧組。

介面說明

本文將提供一個樣本,將杭州地區已有的自助系統管理權限模式的資源棧組MyStackGroup的模板更新為{"ROSTemplateFormatVersion": "2015-09-01"}

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ros:UpdateStackGroup

update

*StackGroup

acs:ros:{#regionId}:{#accountId}:stackgroup/{#StackGroupName}

Template

acs:ros:{#regionId}:{#accountId}:template/{#TemplateId}

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

資源棧組所屬的地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。

cn-hangzhou

StackGroupName

string

資源棧組名稱。名稱在單個地區內唯一。
長度不超過 255 個字元,必須以數字或英文字母開頭,可包含數字、英文字母、短劃線(-)和底線(_)。

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

保證請求的等冪性。該值由用戶端產生,並且必須是全域唯一的。
長度不超過 64 個字元,可包含英文字母、數字、短劃線(-)和底線(_)。
更多資訊,請參見如何保證等冪性

123e4567-e89b-12d3-a456-42665544****

OperationDescription

string

更新資源棧組的操作描述。

Update stack instances in hangzhou

OperationPreferences

object

更新資源棧組的操作設定。

包含以下參數:

  • {"FailureToleranceCount": N}

    容錯數。每個地區中資源棧可以失敗的帳號數,超過該數字將停止該地區中的操作。如果停止了一個地區中的操作,此操作在其他地區中不繼續執行。

    N 的取值範圍:0~20。

    若不指定 FailureToleranceCount,則預設為 0。

  • {"FailureTolerancePercentage": N}

    容錯百分比。每個地區中資源棧可以失敗的帳號數佔總帳號數的百分比,超過該百分比將停止該地區中的操作。

    N 的取值範圍:0~100。百分比不是整數時,ROS 會向下取整。

    若不指定 FailureTolerancePercentage,則預設為 0。

  • {"MaxConcurrentCount": N}

    最大並發帳號數。每個地區中可同時部署資源棧的帳號數。

    N 的取值範圍:1~20。

    若不指定 MaxConcurrentCount,則預設為 1。

  • {"MaxConcurrentPercentage": N}最大並發帳號百分比。

    每個地區中可同時部署資源棧的帳號數佔總帳號數的百分比。

    N 的取值範圍:1~100。百分比不是整數時,ROS 會向下取整。

    若不指定 MaxConcurrentPercentage,則預設為 1。

  • {"RegionConcurrencyType": N} 部署資源棧執行個體的地區層級並發類型,取值:

    • SEQUENTIAL (預設值): 根據地區順序依次在指定的每個地區部署,同一時間只在一個地區部署。

    • PARALLEL :在所有指定的地區內並行部署。

多個參數之間用半形逗號(,)分隔。

說明
  • 不能同時指定 MaxConcurrentCount 和 MaxConcurrentPercentage。

  • 不能同時指定 FailureToleranceCount 和 FailureTolerancePercentage。

{"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(預設值):自助系統管理權限模式。使用該模式時,您需要事先在管理員帳號和目標帳號中手動建立 RAM 角色,建立二者的信任關係,然後在目標帳號中部署資源棧。

  • SERVICE_MANAGED:服務系統管理權限模式。使用該模式時,ROS 會為管理員帳號和目標帳號自動建立服務關聯角色,管理員帳號通過服務關聯角色在目標帳號中部署資源棧。

說明
  • 如果當前資源棧組下已有資源棧執行個體,則不允許更換授權模式。

  • 當您使用服務系統管理權限模式部署資源棧時,當前帳號必須是資來源目錄的企業管理帳號或委派管理員帳號,且已開啟可信訪問。更多資訊,請參見設定委派管理員帳號開啟可信訪問

SELF_MANAGED

AutoDeployment

object

自動部署設定資訊。

說明

僅當 PermissionModel 為 SERVICE_MANAGED 時,需要指定該參數。

{"Enabled": true, "RetainStacksOnAccountRemoval": true}

Enabled

boolean

啟用或者禁用自動部署。

取值:

  • true:啟用自動部署。啟用自動部署後,如果目標資源夾中新增了成員帳號,資源棧組會自動將資源棧執行個體部署到該帳號。如果目標資源夾中刪除了成員帳號,則資源棧組會自動刪除該帳號中的資源棧執行個體。

  • false:禁用自動部署。禁用自動部署後,目標資源夾中成員帳號變動時資源棧執行個體不會發生變化。

true

RetainStacksOnAccountRemoval

boolean

目標資源夾中刪除成員帳號時,是否保留成員帳號中的資源棧。

取值:

  • true:保留資源棧。

  • false:刪除資源棧。

說明

當 Enabled 為 true 時,RetainStacksOnAccountRemoval 必選。

true

DeploymentTargets

object

使用服務系統管理權限模式更新資源棧的部署目標。

{"RdFolderIds": ["fd-4PvlVLOL8v"]}

RdFolderIds

array

資來源目錄的資源夾 ID 列表。

string

資來源目錄的資源夾 ID 列表。最多支援添加 20 個資源夾 ID。

您需要至少指定 RdFolderIds 和 AccountIds 其中一個參數,具體如下:

  • 如果您指定了 RdFolderIds,而未指定 AccountIds,則會在指定資源夾的所有成員帳號中部署資源棧。如果您選擇的是 Root 資源夾,則會在整個資來源目錄的所有成員帳號中部署資源棧。

  • 如果您指定了 AccountIds,而未指定 RdFolderIds,則會在指定成員帳號列表中部署資源棧。

  • 當兩者同時指定時,AccountIds 帳號需屬於 RdFolderIds 所指定的資源夾列表,則會在指定成員帳號列表中部署資源棧。

說明

您可以在資源管理控制台的概覽頁面查看資源夾 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

可選值:

  • Deploy: 更新指定資來源目錄帳號下的現有執行個體。

  • Configure: 修改目標部署資來源目錄,不更新現有執行個體。

關於公用請求參數的詳情,請參見公用參數

返回參數

名稱

類型

描述

樣本值

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****"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情