調用CreateStackGroup建立跨帳號跨地區的資源棧組-Resource Orchestration Service-阿里雲 - Resource Orchestration Service

使用Resource Orchestration Service模板建立資源棧組，通過資源棧組，可以在多個阿里雲帳號中跨地區建立資源棧。

介面說明

資源棧組是針對 ROS 資源棧的嵌入式管理單元。

授權模式

Resource Orchestration Service為您提供自助系統管理權限和服務系統管理權限兩種模式建立資源棧組，您可以使用管理員帳號在不同地區下建立資源棧組，實現跨帳號、跨地區的建立資源棧。更多資訊，請參見概覽。

自助系統管理權限模式

請先為管理員帳號和目標帳號分別建立 RAM 角色並建立二者之間的聯絡。具體操作，請參見授權自助系統管理權限。

當管理員帳號（帳號 A）在杭州地區下建立一個自助系統管理權限模式的資源棧組，可以在杭州地區和北京地區分別為目標帳號（帳號 B 和帳號 C）建立對應的資源棧。其中管理員帳號和目標帳號均為阿里雲帳號。更多資訊，請參見概覽。

當您選擇該模式時，請輸入 PermissionModel 參數為 SELF_MANAGED，並配置 AdministrationRoleName 和 ExecutionRoleName 等相關參數。

服務系統管理權限模式

您可以使用企業管理帳號或委派管理員帳號建立服務系統管理權限模式的資源棧組。更多資訊，請參見設定委派管理員帳號。

管理員帳號（帳號 A）在杭州地區建立一個服務系統管理權限模式的資源棧組，在杭州地區和北京地區分別為資來源目錄中指定的資源夾建立資源棧，此時 ROS 會自動擷取資源夾中的所有成員帳號（帳號 B 和帳號 C）為目標帳號。其中管理員帳號是資來源目錄的企業管理帳號或委派管理員帳號，目標帳號是資來源目錄的成員帳號。更多資訊，請參見概覽。

當您選擇該模式時，請輸入 PermissionModel 參數為 SERVICE_MANAGED，並完成相關參數配置。

您可以在建立服務系統管理權限模式的資源棧組時，開啟自動部署。當對應資源夾中有新帳號加入或帳號移除時，ROS 將會自動對資源棧執行個體進行建立或刪除。

本文將提供一個樣本，在杭州地區cn-hangzhou使用 ID 為5ecd1e10-b0e9-4389-a565-e4c15efc****的模板建立一個名為MyStackGroup的資源棧組，其使用自助系統管理權限模式。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ros:CreateStackGroup

create

*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 個字元。	StackGroup Description
TemplateBody	string	否	模板主體的結構。長度為 1~524,288 個位元組。如果長度較大，則建議通過 HTTP POST+Body Param 的方式，將參數放在請求體中進行傳遞，避免因 URL 過長而導致請求失敗。說明您必須且僅能指定 TemplateBody、TemplateURL、TemplateId 或 StackArn 其中一個參數。	{"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 或 StackArn 其中一個參數。	oss://ros-template/demo
ClientToken	string	否	保證請求的等冪性。該值由用戶端產生，並且必須是全域唯一的。長度不超過 64 個字元，可包含英文字母、數字、短劃線（-）和底線（_）。更多資訊，請參見如何保證等冪性。	123e4567-e89b-12d3-a456-42665544****
AdministrationRoleName	string	否	建立自助系統管理權限模式的資源棧組時，需指定的供 ROS 扮演的 RAM 管理員角色名稱。若不指定，則使用 AliyunROSStackGroupAdministrationRole 作為預設值。ROS 以該角色身份進一步扮演執行角色（AliyunROSStackGroupExecutionRole）來操作資源棧組中資源棧執行個體所對應的資源棧。長度為 1~64 個字元，可包含英文字母、數字和短劃線（-）。說明當 PermissionModel 取值為 SELF_MANAGED 時，該參數必填。	AliyunROSStackGroupAdministrationRole
ExecutionRoleName	string	否	建立自助系統管理權限模式的資源棧組時，需指定的供管理員角色（AliyunROSStackGroupAdministrationRole）扮演的 RAM 執行角色名稱。若不指定，則使用 AliyunROSStackGroupExecutionRole 作為預設值。ROS 以該角色身份來操作資源棧組中資源棧執行個體所對應的資源棧。長度為 1~64 個字元，可包含英文字母、數字和短劃線（-）。說明當 PermissionModel 取值為 SELF_MANAGED 時，該參數必填。	AliyunROSStackGroupExecutionRole
TemplateId	string	否	模板 ID。支援共用模板和私人模板。說明您必須且僅能指定 TemplateBody、TemplateURL、TemplateId 或 StackArn 其中一個參數。	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 為必選參數。	12
ResourceGroupId	string	否	資源群組 ID。如果不指定該參數，資源棧組將加入預設資源群組。關於資源群組的更多資訊，請參見什麼是資源群組。	rg-acfmxazb4ph6aiy****
PermissionModel	string	否	授權模式。取值： SELF_MANAGED（預設值）：自助系統管理權限模式。使用該模式時，您需要事先在管理員帳號和目標帳號中手動建立 RAM 角色，建立二者的信任關係，然後在目標帳號中部署資源棧。 SERVICE_MANAGED：服務系統管理權限模式。使用該模式時，ROS 會為管理員帳號和目標帳號自動建立服務關聯角色，管理員帳號通過服務關聯角色在目標帳號中部署資源棧。說明當您使用服務系統管理權限模式部署資源棧時，當前帳號必須是資來源目錄的企業管理帳號或委派管理員帳號，且已開啟可信訪問。更多資訊，請參見設定委派管理員帳號和開啟可信訪問。	SELF_MANAGED
Tags	array<object>	否	資源棧組的標籤。
	object	否	資源棧組的標籤。
Key	string	是	資源棧組的標籤鍵。說明 Tags 為選擇性參數。如果需要指定 Tags，則 Tags.N.Key 必須指定。	usage
Value	string	否	資源棧組的標籤值。	test
AutoDeployment	object	否	自動部署設定資訊。說明僅當 PermissionModel 為 SERVICE_MANAGED 時，需要指定該參數。	{"Enabled": true, "RetainStacksOnAccountRemoval": true}
Enabled	boolean	否	啟用或者禁用自動部署。取值： true：啟用自動部署。啟用自動部署後，如果目標資源夾中新增了成員帳號，資源棧組會自動將資源棧執行個體部署到該帳號。如果目標資源夾中刪除了成員帳號，則資源棧組會自動刪除該帳號中的資源棧執行個體。 false：禁用自動部署。禁用自動部署後，目標資源夾中成員帳號變動時資源棧執行個體不會發生變化。	true
RetainStacksOnAccountRemoval	boolean	否	目標資源夾中刪除成員帳號時，是否保留成員帳號中的資源棧。取值： true：保留資源棧。 false：刪除資源棧。說明當 Enabled 為 true 時，RetainStacksOnAccountRemoval 必選。	true
Capabilities	array	否	資源棧組選項列表，最大長度為 1。
	string	否	資源棧組選項。可選值：ExpandModules，在當前帳號展開模組。說明僅在模板中使用到模組時生效。預設不在當前帳號展開模組，要求所有部署目標帳號中存在相關模組。如果在當前帳號展開模組，則要求當前帳號存在相關模組。枚舉值： ExpandModules : ExpandModules	ExpandModules
StackArn	string	否	資源棧的 ARN，形如 `acs:ros:${RegionId}:${AccountId}:stack/${StackId}`。資源棧組將根據此資源棧的模板和參數進行建立。說明僅支援自助系統管理權限模式。若指定 StackArn，則不能指定 Parameters。您必須且僅能指定 TemplateBody、TemplateURL、TemplateId 或 StackArn 其中一個參數。	acs:ros:cn-hangzhou:175458000000**:stack/4a65f506-c3cc-43b6-af06-3f000000**

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

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	14A07460-EBE7-47CA-9757-12CC4761D47A
StackGroupId	string	資源棧組 ID。	2c036e78-9e82-428e-afd6-177f5d04****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "StackGroupId": "2c036e78-9e82-428e-afd6-177f5d04****"
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。