文档

UpdateStackInstances - 在特定账号和地域下更新资源栈实例

更新时间:

为一个或多个账号在指定地域下更新资源栈实例。

接口说明

本文将提供一个示例,为杭州地域已有的自助管理权限模式的资源栈组MyStackGroup,在杭州地域和北京地域的阿里云账号151266687691****141261387191****中更新资源栈。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ros:UpdateStackInstancesupdate
  • StackInstance
    acs:ros:{#regionId}:{#accountId}:stackinstance/{#StackGroupName}/{#StackInstanceAccountId}/{#StackInstanceRegionId}

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
StackGroupNamestring

资源栈组名称。名称在单个地域内唯一。
长度不超过 255 个字符,必须以数字或英文字母开头,可以包含数字、英文字母、短划线(-)和下划线(_)。

MyStackGroup
AccountIdsarray

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

说明 使用自助管理权限模式更新资源栈时,此参数必填。
string

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

说明 使用自助管理权限模式更新资源栈时,此参数必填。
["151266687691****","141261387191****"]
RegionIdsarray

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

string

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

["cn-hangzhou","cn-beijing"]
ClientTokenstring

保证请求的幂等性。该值由客户端生成,并且必须是全局唯一的。
长度不超过 64 个字符,可包含英文字母、数字、短划线(-)和下划线(_)。
更多详情,请参见如何保证幂等性

123e4567-e89b-12d3-a456-42665544****
OperationDescriptionstring

更新资源栈的操作描述。

取值范围:1~256 个字符。

Update stack instances in hangzhou and beijing
OperationPreferencesobject

更新资源栈的操作设置。

包含以下参数:

  • {"FailureToleranceCount": N}

    容错数。每个地域中资源栈可以失败的账号数,超过该数字将停止该地域中的操作。如果停止了一个地域中的操作,此操作在其他地域中不继续执行。

    N 的取值范围:0~20。

    若不指定 FailureToleranceCount,则默认为 0。

  • {"FailureTolerancePercentage": N}

    容错百分比。每个地域中资源栈可以失败的账号数占总账号数的百分比,超过该百分比将停止该地域中的操作。

    N 的取值范围:0~100。百分比不是整数时,ROS 会向下取整。

    若不指定 FailureTolerancePercentage,则默认为 0。

  • {"MaxConcurrentCount": N}

    最大并发账号数。每个地域中可同时部署资源栈的账号数。

    N 的取值范围:1~20。

    若不指定 MaxConcurrentCount,则默认为 1。

  • {"MaxConcurrentPercentage": N}

    最大并发账号百分比。每个地域中可同时部署资源栈的账号数占总账号数的百分比。

    取值范围:1~100。百分比不是整数时,ROS 会向下取整。

    若不指定 MaxConcurrentPercentage,则默认为 1。

  • {"RegionConcurrencyType": N} 部署资源栈的地域级别并发类型,取值:

    • SEQUENTIAL (默认值): 根据地域顺序依次在指定的每个地域部署,同一时间只在一个地域部署。

    • PARALLEL :在所有指定的地域内并行部署。

多个参数之间用半角逗号(,)分隔。

说明
  • 不能同时指定 MaxConcurrentCount 和 MaxConcurrentPercentage。
  • 不能同时指定 FailureToleranceCount 和 FailureTolerancePercentage。
  • {"FailureToleranceCount": 1,"MaxConcurrentCount": 2}
    TimeoutInMinuteslong

    更新资源栈的超时时间。

    • 默认值:60。

    • 单位:分钟。

    10
    ParameterOverridesarray<object>

    覆盖参数列表。

    object
    ParameterKeystring

    覆盖参数的名称。如果未指定参数名称,ROS 将使用创建资源栈组时所指定的参数名称。

    N 最大值为 200。

    说明
  • ParameterOverrides 为可选参数。
  • 如果需要指定 ParameterOverrides,则 ParameterOverrides.N.ParameterKey 和 ParameterOverrides.N.ParameterValue 必须同时指定。
  • Amount
    ParameterValuestring

    覆盖参数的值。如果未指定特定参数的名称和值,ROS 将使用创建资源栈组时所指定的参数。

    N 最大值为 200。

    说明
  • ParameterOverrides 为可选参数。
  • 如果需要指定 ParameterOverrides,则 ParameterOverrides.N.ParameterKey 和 ParameterOverrides.N.ParameterValue 必须同时指定。
  • 1
    DeploymentTargetsobject

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

    说明 使用服务管理权限模式更新资源栈时,此参数必填。
    RdFolderIdsarray

    资源目录的资源夹 ID 列表。

    string

    资源目录的资源夹 ID 列表。最多支持添加 20 个资源夹 ID。

    您需要至少指定 RdFolderIds 和 AccountIds 其中一个参数,具体如下:

    • 如果您指定了 RdFolderIds,而未指定 AccountIds,则会在指定资源夹的所有成员账号中部署资源栈。如果您选择的是 Root 资源夹,则会在整个资源目录的所有成员账号中部署资源栈。

    • 如果您指定了 AccountIds,而未指定 RdFolderIds,则会在指定成员账号列表中部署资源栈。

    • 当两者同时指定时,AccountIds 账号需属于 RdFolderIds 所指定的资源夹列表,则会在指定成员账号列表中部署资源栈。

    说明 您可以在资源管理控制台的概览页面查看资源夹 ID。具体操作,请参见查看资源夹基本信息
    ["fd-4PvlVLOL8v"]
    AccountIdsarray

    资源目录中的成员账号 ID 列表。最多支持添加 30 个成员账号 ID。

    说明 您可以在资源管理控制台的概览页面查看成员账号 ID。具体操作,请参见查看成员详情
    string

    资源目录中的成员账号 ID 列表。最多支持添加 30 个成员账号 ID。

    说明 您可以在资源管理控制台的概览页面查看成员账号 ID。具体操作,请参见查看成员详情
    ["151266687691****","141261387191****"]

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

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    14A07460-EBE7-47CA-9757-12CC4761D47A
    OperationIdstring

    操作 ID。

    6da106ca-1784-4a6f-a7e1-e723863d****

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
      "OperationId": "6da106ca-1784-4a6f-a7e1-e723863d****"
    }

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    暂无变更历史
    错误代码错误信息HTTP 状态码描述
    InvalidParameterThe specified parameter {name} is invalid, {reason}.400无效参数,name 为参数名,reason 为原因。
    StackGroupNotFoundThe StackGroup ({name}) could not be found.404资源栈组不存在。name 为资源栈组名称。
    StackGroupOperationInProgressAnother Operation on StackGroup ({name}) is in progress.409资源栈组存在进行中的操作。name 为资源栈组名称。