调用UpdateStackInstances接口在指定目标账号和地域下更新资源栈实例。

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String UpdateStackInstances

要执行的操作。取值:UpdateStackInstances。

RegionId String cn-hangzhou

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

StackGroupName String MyStackGroup

资源栈组名称。名称在单个地域内唯一。

长度不超过255个字符,必须以数字或英文字母开头,可以包含数字、英文字母、短划线(-)和下划线(_)。

AccountIds Array of String ["151266687691****","141261387191****"]

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

说明 使用自助管理权限模式更新资源栈实例时,此参数必填。
RegionIds Array of String ["cn-hangzhou","cn-beijing"]

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

ClientToken String 123e4567-e89b-12d3-a456-42665544****

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

长度不超过64个字符,可包含英文字母、数字、短划线(-)和下划线(_)。

更多详情,请参见如何保证幂等性

OperationDescription String Update stack instances in hangzhou and beijing

更新资源栈实例的操作描述。

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

OperationPreferences Map {"FailureToleranceCount": 1,"MaxConcurrentCount": 2}

更新资源栈实例的操作设置。

包含以下参数:

  • {"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。

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

说明
  • 不能同时指定MaxConcurrentCount和MaxConcurrentPercentage。
  • 不能同时指定FailureToleranceCount和FailureTolerancePercentage。
TimeoutInMinutes Long 10

更新资源栈实例的超时时间。

  • 默认值:60。
  • 单位:分钟。
DeploymentTargets Object

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

说明 使用服务管理权限模式更新资源栈实例时,此参数必填。
RdFolderIds Array of String ["fd-4PvlVLOL8v"]

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

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

  • 如果您指定了RdFolderIds,而未指定AccountIds,则会在指定资源夹的所有成员账号中部署资源栈。如果您选择的是Root资源夹,则会在整个资源目录的所有成员账号中部署资源栈。
  • 如果您指定了AccountIds,而未指定RdFolderIds,则会在指定成员账号列表中部署资源栈。
  • 当两者同时指定时,AccountIds账号需属于RdFolderIds所指定的资源夹列表,则会在指定成员账号列表中部署资源栈。
说明 您可以在资源管理控制台的概览页面查看资源夹ID。具体操作,请参见查看资源夹基本信息
AccountIds Array of String ["151266687691****","141261387191****"]

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

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

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

N最大值为200。

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

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

N最大值为200。

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

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

返回数据

名称 类型 示例值 描述
RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A

请求ID。

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

操作ID。

示例

请求示例

http(s)://ros.aliyuncs.com/?Action=UpdateStackInstances
&AccountIds=["151266687691****","141261387191****"]
&RegionId=cn-hangzhou
&RegionIds=["cn-hangzhou","cn-beijing"]
&StackGroupName=MyStackGroup
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateStackInstancesResponse>
		<OperationId>6da106ca-1784-4a6f-a7e1-e723863d****</OperationId>
		<RequestId>14A07460-EBE7-47CA-9757-12CC4761D47A</RequestId>
</UpdateStackInstancesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

错误代码

错误信息

HTTP状态码

描述

InvalidParameter

The specified parameter {name} is invalid, {reason}.

400

无效参数,name为参数名,reason为原因。

StackGroupNotFound

The StackGroup ({name}) could not be found.

404

资源栈组不存在。name为资源栈组名称。

StackGroupOperationInProgress

Another Operation on StackGroup ({name}) is in progress.

409

资源栈组存在进行中的操作。name为资源栈组名称。