UpdateStackGroup_资源编排_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

本文将提供一个示例,将杭州地域已有的自助管理权限模式的资源栈组MyStackGroup的模板更新为{"ROSTemplateFormatVersion": "2015-09-01"}

流控信息

请求速率为100/60(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
ros:UpdateStackGroup
Update
StackGroup
acs:ros:{#regionId}:{#accountId}:stackgroup/{#StackGroupName}

请求参数

字段名称字段详情
RegionIdstring

资源栈组所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
StackGroupNamestring

资源栈组名称。名称在单个地域内唯一。 展开详情

示例值:MyStackGroup参考取值来源:
    GetStackGroup
    CreateStackGroup
    ListStackGroups
    ImportStacksToStackGroup
Descriptionstring

资源栈组描述。展开详情

示例值:My Stack Group
AccountIdsarray<string>

使用自助管理权限模式部署资源栈的目标账号 ID 列表。最多支持添加 30 个目标账号 ID。

示例值:["12****"]
RegionIdsarray<string>

目标执行地域列表。最多支持添加 20 个地域。

示例值:["cn-hangzhou", "cn-beijing"]
TemplateBodystring

模板主体的结构。长度为 1~524,288 个字节。如果长度较大,则建议通过 HTTP POST+Body Param 的方式,将参数放在请求体中进行传递,避免因 URL 过长而导致请求失败。 展开详情

示例值:{"ROSTemplateFormatVersion": "2015-09-01"}参考取值来源:
    GetTemplate
    UpdateStackTemplateByResources
    GenerateTemplateByScratch
TemplateURLstring

包含模板主体的文件的位置。URL 必须指向位于 HTTP Web 服务器(HTTP 或 HTTPS)或阿里云 OSS 存储桶中的模板(1~524,288 个字节)。OSS 存储桶的 URL,例如 oss://ros/template/demo 或 oss://ros/template/demo?RegionId=cn-hangzhou。如未指定 OSS 地域,默认与接口参数 RegionId 相同。展开详情

示例值:oss://ros-template/demo
ClientTokenstring

保证请求的幂等性。该值由客户端生成,并且必须是全局唯一的。 展开详情

示例值:123e4567-e89b-12d3-a456-42665544****
OperationDescriptionstring

更新资源栈组的操作描述。

示例值:Update stack instances in hangzhou
OperationPreferencesobject

更新资源栈组的操作设置。展开详情

示例值:{"FailureToleranceCount": 1,"MaxConcurrentCount": 2}参考取值来源:
    GetStackGroupOperation
AdministrationRoleNamestring

创建具有自助管理权限的资源栈组时,需指定的供 ROS 扮演的 RAM 管理员角色名称。若不指定,则使用 AliyunROSStackGroupAdministrationRole 作为默认值。ROS 以该角色身份进一步扮演执行角色(AliyunROSStackGroupExecutionRole)来操作资源栈组中资源栈实例所对应的资源栈。展开详情

示例值:AliyunROSStackGroupAdministrationRole
ExecutionRoleNamestring

创建具有自助管理权限的资源栈组时,需指定的供管理员角色(AliyunROSStackGroupAdministrationRole)扮演的 RAM 执行角色名称。若不指定,则使用 AliyunROSStackGroupExecutionRole 作为默认值。ROS 以该角色身份来操作资源栈组中资源栈实例所对应的资源栈。展开详情

示例值:AliyunROSStackGroupExecutionRole
TemplateIdstring

模板 ID。支持共享模板和私有模板。展开详情

示例值:5ecd1e10-b0e9-4389-a565-e4c15efc****参考取值来源:
    GetTemplate
    UpdateTemplate
    ListTemplates
    CreateTemplate
TemplateVersionstring

模板版本。若不指定,默认取最新版本。展开详情

示例值:v1参考取值来源:
    ListTemplateVersions
    GetTemplate
    UpdateTemplate
Parametersarray<object>

资源栈组参数列表。

子级条数 <= 200
PermissionModelstring

授权模式。展开详情

示例值:SELF_MANAGED
AutoDeploymentobject

自动部署设置信息。展开详情

示例值:{"Enabled": true, "RetainStacksOnAccountRemoval": true}
DeploymentTargetsobject

使用服务管理权限模式更新资源栈的部署目标。

示例值:{"RdFolderIds": ["fd-4PvlVLOL8v"]}
Capabilitiesarray<string>

资源栈组选项列表,最大长度为 1。

子级条数 <= 1
DeploymentOptionsarray<string>

使用服务管理权限模式更新资源栈组的部署选项列表。最多支持 1 个部署选项。

子级条数 <= 1

请求说明

关于公共请求参数的详情,请参见公共参数

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:14A07460-EBE7-47CA-9757-12CC4761D47A
OperationIdstring

操作 ID。

示例值:6da106ca-1784-4a6f-a7e1-e723863d****

返回示例

变更历史

变更时间变更内容概要操作
2024-11-21
新增请求参数DeploymentOptions
2024-01-11
变更请求参数TemplateBody
2023-05-10
新增请求参数Capabilities

相关示例

调用UpdateStackGroup接口更新资源栈组。
2022-09-19