更新已创建的资源栈组。
接口说明
本文将提供一个示例,将杭州地域已有的自助管理权限模式的资源栈组MyStackGroup
的模板更新为{"ROSTemplateFormatVersion": "2015-09-01"}
。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ros:UpdateStackGroup | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 | 否 | 源栈组选项。可选值:ExpandModules,在当前账号展开模块。 说明
| ExpandModules |
关于公共请求参数的详情,请参见公共参数。
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
"OperationId": "6da106ca-1784-4a6f-a7e1-e723863d****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
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 为模板版本。 |