更新已創建的資源棧組。
接口說明
本文將提供一個示例,將杭州地域已有的自助管理權限模式的資源棧組MyStackGroup
的模板更新為{"ROSTemplateFormatVersion": "2015-09-01"}
。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ros:UpdateStackGroup | update | *StackGroup acs:ros:{#regionId}:{#accountId}:stackgroup/{#StackGroupName} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 資源棧組所屬的地域 ID。您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
StackGroupName | string | 是 | 資源棧組名稱。名稱在單個地域內唯一。 | MyStackGroup |
Description | string | 否 | 資源棧組描述。 長度為 1~256 個字符。 | My Stack Group |
AccountIds | array | 否 | 使用自助管理權限模式部署資源棧的目標賬號 ID 列表。最多支持添加 30 個目標賬號 ID。 | |
string | 否 | 使用自助管理權限模式部署資源棧的目標賬號 ID 列表。最多支持添加 30 個目標賬號 ID。 | ["151266687691****","141261387191****"] | |
RegionIds | array | 否 | 目標執行地域列表。最多支持添加 20 個地域。 | |
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 | boolean | 是 | 啟用或者禁用自動部署。 取值:
| true |
RetainStacksOnAccountRemoval | boolean | 否 | 目標資源夾中刪除成員賬號時,是否保留成員賬號中的資源棧。 取值:
說明
當 Enabled 為 true 時,RetainStacksOnAccountRemoval 必選。
| true |
DeploymentTargets | object | 否 | 使用服務管理權限模式更新資源棧的部署目標。 | |
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 | 否 | 源棧組選項??蛇x值:ExpandModules,在當前賬號展開模塊。 說明
| ExpandModules | |
DeploymentOptions | array | 否 | 使用服務管理權限模式更新資源棧組的部署選項列表。最多支持 1 個部署選項。 | |
string | 否 | 可選值:
|
關于公共請求參數的詳情,請參見公共參數。
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
"OperationId": "6da106ca-1784-4a6f-a7e1-e723863d****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-11-21 | OpenAPI 入參發生變更 | 查看變更詳情 |
2024-01-11 | API 內部配置變更,不影響調用 | 查看變更詳情 |
2023-05-10 | OpenAPI 入參發生變更 | 查看變更詳情 |
錯誤代碼 | 錯誤信息 | HTTP 狀態碼 | 描述 |
---|---|---|---|
CircularDependency | Circular Dependency Found: {reason}. | 400 | 模板包含循環引用。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 | 傳遞的參數在模板中未定義。name 為參數名。 |
UserParameterMissing | The Parameter {name} was not provided. | 400 | 參數在模板中已定義,但未傳遞值。name 為參數名。 |
StackGroupOperationInProgress | Another Operation on StackGroup ({name})s is in progress. | 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 為模板版本。 |