Updates the stack instances that are created within a specified account in a specified region.

In this example, the stack instances that are created in a stack group named MyStackGroup are updated. The stack instances are created within the 151266687691∗∗∗∗ and 141261387191∗∗∗∗ accounts in the China (Hangzhou) and China (Beijing) regions. The stack group is granted self-managed permissions and created in the China (Hangzhou) region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateStackInstances

The operation that you want to perform. Set the value to UpdateStackInstances.

RegionId String Yes cn-hangzhou

The region ID of the stack group. You can call the DescribeRegions operation to query the most recent region list.

StackGroupName String Yes MyStackGroup

The name of the stack group. The name must be unique within a region.

The name can be up to 255 characters in length, and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter.

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

The IDs of the accounts within which you use the self-managed permission model to deploy stacks. You can specify a maximum of 20 account IDs.

Note You must specify this parameter when you use the self-managed permission model to update the stack instances.
RegionIds Array of String Yes ["cn-hangzhou","cn-beijing"]

The region IDs of the stack instances. You can specify a maximum of 20 region IDs.

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

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests.

The token can be up to 64 characters in length, and can contain letters, digits, hyphens (-), and underscores (_).

For more information, see Ensure idempotence.

OperationDescription String No Update stack instances in hangzhou and beijing

The description of the operation to update the stack instances.

The description must be 1 to 256 characters in length.

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

The preferences of the operation to update the stack instances.

Available parameters for the operation preferences:

  • {"FailureToleranceCount": N}

    The maximum number of stack operation failures that can occur within the accounts in each region. When the value is exceeded, ROS stops the operation in the region. If ROS stops the operation in one region, ROS stops the operation in other regions.

    Valid values of N: 0 to 20.

    If you do not specify the FailureToleranceCount parameter, the default value 0 is used.

  • {"FailureTolerancePercentage": N}

    The percentage of the total number of accounts within which stack operation failures can occur to the total number of accounts in each region. When the value is exceeded, ROS stops the operation in the region.

    Valid values of N: 0 to 100. If the numeric value in the percentage is not an integer, Resource Orchestration Service (ROS) rounds the number down to the nearest integer.

    If you do not specify the FailureTolerancePercentage parameter, the default value 0 is used.

  • {"MaxConcurrentCount": N}

    The maximum number of accounts within which operations are concurrently performed on stacks in each region.

    Valid values of N: 1 to 20.

    If you do not specify the MaxConcurrentCount parameter, the default value 1 is used.

  • {"MaxConcurrentPercentage": N}

    The percentage of the total number of accounts within which operations are concurrently performed on stacks to the total number of accounts in each region.

    Valid values of N: 1 to 100. If the numeric value in the percentage is not an integer, ROS rounds the number down to the nearest integer.

    If you do not specify the MaxConcurrentPercentage parameter, the default value 1 is used.

Separate multiple parameters with commas (,).

Note
  • You can specify one of the MaxConcurrentCount and MaxConcurrentPercentage parameters.
  • You can specify one of the FailureToleranceCount and FailureTolerancePercentage parameters.
TimeoutInMinutes Long No 10

The timeout period to update the stack group.

  • Default value: 60.
  • Unit: minutes.
DeploymentTargets Object No

The folders in which you use the service-managed permission model to deploy stacks.

Note You must specify this parameter when you use the service-managed permission model to update the stack instances.
RdFolderIds Array of String No ["fd-4PvlVLOL8v"]

The folder IDs of the resource directory. You can specify a maximum of five folder IDs.

You must specify at least one of the RdFolderIds and AccountIds parameters. The parameters are subject to the following items:

  • If you specify only the RdFolderIds parameter, stacks are deployed within all the member accounts in the specified folders. If you deploy the stacks in the Root folder, the stacks are deployed within all the member accounts in the resource directory.
  • If you specify only the AccountIds parameter, stacks are deployed within the specified member accounts.
  • If you specify both parameters, the accounts specified by AccountIds must be contained in the folders specified by RdFolderIds.
Note To view the folder IDs, go to the overview page in the Resource Management console. For more information, see View the basic information about a folder.
AccountIds Array of String No ["151266687691****","141261387191****"]

The IDs of the member accounts in the resource directory. You can specify a maximum of 20 member account IDs.

Note To view the member account IDs, go to the overview page in the Resource Management console. For more information, see View the detailed information about a member.
ParameterOverrides.N.ParameterKey String Yes Amount

The key of override parameter N. If you do not specify the key of this parameter, ROS uses the key that you specify when you create the stack group.

Maximum value of N: 200.

Note
  • ParameterOverrides in ParameterOverrides.N.ParameterKey is optional.
  • If you specify ParameterOverrides, you must specify the ParameterOverrides.N.ParameterKey and ParameterOverrides.N.ParameterValue parameters.
ParameterOverrides.N.ParameterValue String Yes 1

The value of override parameter N. If you do not specify the key and value of this parameter, ROS uses the key and the value that you specify when you create the stack group.

Maximum value of N: 200.

Note
  • ParameterOverrides in ParameterOverrides.N.ParameterValue is optional.
  • If you specify ParameterOverrides, you must specify the ParameterOverrides.N.ParameterKey and ParameterOverrides.N.ParameterValue parameters.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A

The ID of the request.

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

The ID of the operation.

Examples

Sample requests

http(s)://ros.aliyuncs.com/?Action=UpdateStackInstances
&AccountIds=["151266687691****","141261387191****"]
&RegionId=cn-hangzhou
&RegionIds=["cn-hangzhou","cn-beijing"]
&StackGroupName=MyStackGroup
&<Common request parameters>

Sample success responses

XML format

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 format

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

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

Error codes

For a list of error codes, visit the API Error Center.

Error code

Error message

HTTP status code

Description

InvalidParameter

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

400

The error message returned because the specified parameter is invalid. name indicates the parameter name. reason indicates the reason for the error.

StackGroupNotFound

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

404

The error message returned because the specified stack group does not exist. name indicates the name of the stack group.

StackGroupOperationInProgress

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

409

The error message returned because an operation is being performed on the stack group. name indicates the name of the stack group.