You can call this operation to update a stack group.

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 UpdateStackGroup

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

Parameters.N.ParameterKey String Yes Amount

The name of parameter N. If the name and value of the parameter are not specified, the name and value specified in the template are used.

Maximum value of N: 200.

Parameters.N.ParameterValue String Yes 1

The value of parameter N.

Maximum value of N: 200.

RegionId String Yes cn-hangzhou

The region ID of the stack. 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 in 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.

Description String No My Stack Group

The description of the stack group.

The description must be 1 to 256 characters in length.

AccountIds JSON No ["123456"]

The list of target account IDs, in JSON format. A maximum of 20 IDs are supported.

RegionIds JSON No ["cn-hangzhou", "cn-beijing"]

The list of target regions, in JSON format. A maximum of 20 regions are supported.

TemplateBody String No { "ROSTemplateFormatVersion": "2015-09-01" }

The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body is longer than required, we recommend that you add parameters to the HTTP POST request body to avoid request failures due to excessive length of URLs. You must specify either the TemplateBody parameter or the TemplateURL parameter. But you cannot specify both of them.

TemplateURL String No oss://ros-template/demo

The URL for the file that contains the template body. The URL must point to a template located in an HTTP or HTTPS web server or an Alibaba Cloud OSS bucket. Examples: oss://ros/template/demo and oss://ros/template/demo?RegionId=cn-hangzhou. If the region of the OSS bucket is not specified, the RegionId parameter value is used by default. The template can be up to 524,288 bytes in length.

You must specify either the TemplateBody parameter or the TemplateURL parameter. But you cannot specify both of them.

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

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 ensure that it is unique among different requests. The token can contain only letters, digits, hyphens (-), and underscores (_) and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

OperationDescription String No Update stack instances in hangzhou

The description of the operation. The description describes the purpose or action of the operation.

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

The operation settings, in JSON format. The following fields are supported:

  • FailureToleranceCount

The maximum number of stack operation failures that can occur. In a stack group operation, if the total number of failures does not exceed the FailureToleranceCount value, the operation succeeds. Otherwise, the operation fails.

If the FailureToleranceCount parameter is not specified, the default value is 0. You can specify either the FailureToleranceCount parameter or the FailureTolerancePercentage parameter. But you cannot specify both of them.

Valid values: 0 to 20.

  • FailureTolerancePercentage

The percentage of stack operation failures that can occur. In a stack group operation, if the percentage of failures does not exceed the FailureTolerancePercentage value, the operation succeeds. Otherwise, the operation fails.

You can specify either the FailureToleranceCount parameter or the FailureTolerancePercentage parameter. But you cannot specify both of them.

Valid values: 0 to 100.

  • MaxConcurrentCount

The maximum number of target accounts in which a stack group operation can be performed at one time.

You can specify either the MaxConcurrentCount parameter or the MaxConcurrentPercentage parameter. But you cannot specify both of them.

Valid values: 1 to 20.

  • MaxConcurrentPercentage

The maximum percentage of target accounts in which a stack group operation can be performed at one time.

You can specify either the FailureToleranceCount parameter or the FailureTolerancePercentage parameter. But you cannot specify both of them.

Valid values: 1 to 100.

AdministrationRoleName String No AliyunROSStackGroupAdministrationRole

The name of the RAM administrator role assumed by ROS. ROS assumes this role to play the execution role to operate on the stack corresponding to the stack instance in the stack group.

The RAM role is specified only when the custom administrator role is used to control the users or groups that can manage specified stack groups under the same administrator account. Default value: AliyunROSStackGroupAdministrationRole.

The name must be 1 to 64 characters in length and can contain letters, digits, and hyphens (-).

ExecutionRoleName String No AliyunROSStackGroupExecutionRole

The name of the RAM execution role assumed by the administrator role. ROS plays this role to operate on the stack corresponding to the stack instance in the stack group.

Default value: AliyunROSStackGroupExecutionRole.

The name must be 1 to 64 characters in length and can contain letters, digits, and hyphens (-).

Response parameters

Parameter Type Example Description
OperationId String 6da106ca-1784-4a6f-a7e1-e723863dc75a

The ID of the operation.

RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=UpdateStackGroup
&Parameters.1.ParameterKey=Amount
&Parameters.1.ParameterValue=1
&RegionId=cn-hangzhou
&StackGroupName=MyStackGroup
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

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