使用資源編排模板創(chuàng)建資源棧組,通過資源棧組,可以在多個阿里云賬號中跨地域創(chuàng)建資源棧。
接口說明
資源棧組是針對 ROS 資源棧的管理單元。
授權(quán)模式
資源編排為您提供自助管理權(quán)限和服務(wù)管理權(quán)限兩種模式創(chuàng)建資源棧組, 您可以使用管理員賬號在不同地域下創(chuàng)建資源棧組,實現(xiàn)跨賬號、跨地域的創(chuàng)建資源棧。更多信息,請參見概覽。
自助管理權(quán)限模式
請先為管理員賬號和目標賬號分別創(chuàng)建 RAM 角色并建立二者之間的聯(lián)系。具體操作,請參見授權(quán)自助管理權(quán)限。
當管理員賬號(賬號 A)在杭州地域下創(chuàng)建一個自助管理權(quán)限模式的資源棧組,可以在杭州地域和北京地域分別為目標賬號(賬號 B 和賬號 C)創(chuàng)建對應(yīng)的資源棧。其中管理員賬號和目標賬號均為阿里云賬號。更多信息,請參見概覽。
當您選擇該模式時,請輸入 PermissionModel 參數(shù)為 SELF_MANAGED,并配置 AdministrationRoleName 和 ExecutionRoleName 等相關(guān)參數(shù)。
服務(wù)管理權(quán)限模式
您可以使用企業(yè)管理賬號或委派管理員賬號創(chuàng)建服務(wù)管理權(quán)限模式的資源棧組。更多信息,請參見設(shè)置委派管理員賬號。
管理員賬號(賬號 A)在杭州地域創(chuàng)建一個服務(wù)管理權(quán)限模式的資源棧組,在杭州地域和北京地域分別為資源目錄中指定的資源夾創(chuàng)建資源棧,此時 ROS 會自動獲取資源夾中的所有成員賬號(賬號 B 和賬號 C)為目標賬號。其中管理員賬號是資源目錄的企業(yè)管理賬號或委派管理員賬號,目標賬號是資源目錄的成員賬號。更多信息,請參見概覽。
當您選擇該模式時,請輸入 PermissionModel 參數(shù)為 SERVICE_MANAGED,并完成相關(guān)參數(shù)配置。
您可以在創(chuàng)建服務(wù)管理權(quán)限模式的資源棧組時,開啟自動部署。當對應(yīng)資源夾中有新賬號加入或賬號移除時,ROS 將會自動對資源棧實例進行創(chuàng)建或刪除。
本文將提供一個示例,在杭州地域cn-hangzhou
使用 ID 為5ecd1e10-b0e9-4389-a565-e4c15efc****
的模板創(chuàng)建一個名為MyStackGroup
的資源棧組,其使用自助管理權(quán)限模式。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
ros:CreateStackGroup | create |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 資源棧組所屬的地域 ID。 您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
StackGroupName | string | 是 | 資源棧組名稱。名稱在單個地域內(nèi)唯一。 | MyStackGroup |
Description | string | 否 | 資源棧組描述。 | StackGroup Description |
TemplateBody | string | 否 | 模板主體的結(jié)構(gòu)。長度為 1~524,288 個字節(jié)。如果長度較大,則建議通過 HTTP POST+Body Param 的方式,將參數(shù)放在請求體中進行傳遞,避免因 URL 過長而導(dǎo)致請求失敗。 說明
您必須且僅能指定 TemplateBody、TemplateURL、TemplateId 或 StackArn 其中一個參數(shù)。
| {"ROSTemplateFormatVersion":"2015-09-01"} |
TemplateURL | string | 否 | 包含模板主體的文件的位置。URL 必須指向位于 HTTP Web 服務(wù)器(HTTP 或 HTTPS)或阿里云 OSS 存儲桶中的模板(1~524,288 個字節(jié))。OSS 存儲桶的 URL,例如 oss://ros/template/demo 或 oss://ros/template/demo?RegionId=cn-hangzhou。如未指定 OSS 地域,默認與接口參數(shù) RegionId 相同。 說明
您必須且僅能指定 TemplateBody、TemplateURL、TemplateId 或 StackArn 其中一個參數(shù)。
| oss://ros-template/demo |
ClientToken | string | 否 | 保證請求的冪等性。該值由客戶端生成,并且必須是全局唯一的。 | 123e4567-e89b-12d3-a456-42665544**** |
AdministrationRoleName | string | 否 | 創(chuàng)建自助管理權(quán)限模式的資源棧組時,需指定的供 ROS 扮演的 RAM 管理員角色名稱。若不指定,則使用 AliyunROSStackGroupAdministrationRole 作為默認值。ROS 以該角色身份進一步扮演執(zhí)行角色(AliyunROSStackGroupExecutionRole)來操作資源棧組中資源棧實例所對應(yīng)的資源棧。 長度為 1~64 個字符,可包含英文字母、數(shù)字和短劃線(-)。 說明
當 PermissionModel 取值為 SELF_MANAGED 時,該參數(shù)必填。
| AliyunROSStackGroupAdministrationRole |
ExecutionRoleName | string | 否 | 創(chuàng)建自助管理權(quán)限模式的資源棧組時,需指定的供管理員角色(AliyunROSStackGroupAdministrationRole)扮演的 RAM 執(zhí)行角色名稱。若不指定,則使用 AliyunROSStackGroupExecutionRole 作為默認值。ROS 以該角色身份來操作資源棧組中資源棧實例所對應(yīng)的資源棧。 長度為 1~64 個字符,可包含英文字母、數(shù)字和短劃線(-)。 說明
當 PermissionModel 取值為 SELF_MANAGED 時,該參數(shù)必填。
| AliyunROSStackGroupExecutionRole |
TemplateId | string | 否 | 模板 ID。支持共享模板和私有模板。 說明
您必須且僅能指定 TemplateBody、TemplateURL、TemplateId 或 StackArn 其中一個參數(shù)。
| 5ecd1e10-b0e9-4389-a565-e4c15efc**** |
TemplateVersion | string | 否 | 模板版本。如果不指定,默認取最新版本。 說明
TemplateVersion 僅在指定 TemplateId 時生效。
| v1 |
Parameters | array<object> | 否 | 資源棧組參數(shù)列表。 | |
object | 否 | |||
ParameterKey | string | 是 | 參數(shù)的名稱。如果未指定參數(shù)的名稱和值,則 ROS 將使用模板中指定的默認值。 N 最大值為 200。 說明
Parameters 為可選參數(shù)。若指定了 Parameters,則 Parameters.N.ParameterKey 為必選參數(shù)。
| Amount |
ParameterValue | string | 是 | 參數(shù)的值。 N 最大值為 200。 說明
Parameters 為可選參數(shù)。若指定了 Parameters,則 Parameters.N.ParameterValue 為必選參數(shù)。
| 12 |
ResourceGroupId | string | 否 | 資源組 ID。如果不指定該參數(shù),資源棧組將加入默認資源組。 | rg-acfmxazb4ph6aiy**** |
PermissionModel | string | 否 | 授權(quán)模式。 取值:
說明
當您使用服務(wù)管理權(quán)限模式部署資源棧時,當前賬號必須是資源目錄的企業(yè)管理賬號或委派管理員賬號,且已開啟可信訪問。更多信息,請參見設(shè)置委派管理員賬號和開啟可信訪問。
| SELF_MANAGED |
Tags | array<object> | 否 | 資源棧組的標簽。 | |
object | 否 | 資源棧組的標簽。 | ||
Key | string | 是 | 資源棧組的標簽鍵。 說明
Tags 為可選參數(shù)。如果需要指定 Tags,則 Tags.N.Key 必須指定。
| usage |
Value | string | 否 | 資源棧組的標簽值。 | test |
AutoDeployment | object | 否 | 自動部署設(shè)置信息。 說明
僅當 PermissionModel 為 SERVICE_MANAGED 時,需要指定該參數(shù)。
| |
Enabled | boolean | 是 | 啟用或者禁用自動部署。 取值:
| true |
RetainStacksOnAccountRemoval | boolean | 否 | 目標資源夾中刪除成員賬號時,是否保留成員賬號中的資源棧。 取值:
說明
當 Enabled 為 true 時,RetainStacksOnAccountRemoval 必選。
| true |
Capabilities | array | 否 | 資源棧組選項列表,最大長度為 1。 | |
string | 否 | 資源棧組選項。可選值:ExpandModules,在當前賬號展開模塊。 說明
| ExpandModules | |
StackArn | string | 否 | 資源棧的 ARN,形如 說明
| acs:ros:cn-hangzhou:175458000000****:stack/4a65f506-c3cc-43b6-af06-3f000000**** |
關(guān)于公共請求參數(shù)的詳情,請參見公共參數(shù)。
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
"StackGroupId": "2c036e78-9e82-428e-afd6-177f5d04****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-09-12 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2024-01-11 | API 內(nèi)部配置變更,不影響調(diào)用 | 查看變更詳情 |
2023-05-10 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2022-10-27 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
錯誤代碼 | 錯誤信息 | HTTP 狀態(tài)碼 | 描述 |
---|---|---|---|
CircularDependency | Circular Dependency Found: {reason}. | 400 | 模板包含循環(huán)引用,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 為具體原因。 |
UnknownUserParameter | The Parameter ({name}) was not defined in template. | 400 | 傳遞的參數(shù)在模板中未定義,name 為參數(shù)名。 |
UserParameterMissing | The Parameter {name} was not provided. | 400 | 參數(shù)在模板中已定義,但未傳遞值,name 為參數(shù)名。 |
StackGroupExists | The StackGroup ({name}) already exists. | 409 | 同名資源棧組已存在,name 為資源棧組名稱。 |
TemplateNotFound | The Tempalte ({ ID }) could not be found. | 404 | 模板不存在。ID 為模板 ID。 |
TemplateNotFound | The Template { ID } with version { version } could not be found. | 404 | 模板或指定版本不存在。ID 為模板 ID,version 為模板版本。 |