Deletes the stack instances from a stack group within a specified account in a specified region.

In this example, the stack instances that are deployed in the China (Beijing) region within the 151266687691∗∗∗∗ account are deleted from a stack group named MyStackGroup. The stack group is granted with self-managed permissions and deployed 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 DeleteStackInstances

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

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 in which the stacks contained in the stack group are granted with self-managed permissions. You can specify a maximum of 20 account IDs.

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.

RetainStacks Boolean Yes false

Specifies whether to retain the relevant stacks when you delete the stack instances from the stack group.

Valid values:

  • true: The stacks are retained.
  • false: The stacks are deleted.
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 Delete stack instances in hangzhou and beijing

The description of the deletion operation.

The description must be 1 to 256 characters in length.

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

The parameters that you configure to delete the stack instances.

Valid values:

  • {"FailureToleranceCount": N}

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

    Valid values of N: 0 to 20. Default value: 0.

    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, the operation fails to be performed in the region.

    Valid values of N: 0 to 100. Default value: 0. 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 in which operations are performed on stacks concurrently in each region.

    Valid values of N: 1 to 20. Default value: 1.

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

  • {"MaxConcurrentPercentage": N}

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

    Valid values of N: 1 to 100. Default value: 1. 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 only one of the MaxConcurrentCount and MaxConcurrentPercentage parameters.
  • You can specify only one of the FailureToleranceCount and FailureTolerancePercentage parameters.
DeploymentTargets Object No

The folders in which you want to deploy the stacks granted with service-managed permissions.

RdFolderIds Array of String Yes ["fd-4PvlVLOL8v"]

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

You can create stack instances in all the member accounts that are contained in the specified folders. If you create stack instances in the Root folder, the stack instances are created in all the member accounts in the resource directory.

Note To view the folder IDs, go to the overview page in the Resource Management console. For more information, see View the basic information of a folder.

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=DeleteStackInstances
&AccountIds=["151266687691****"]
&RegionId=cn-hangzhou
&RegionIds=["cn-beijing"]
&StackGroupName=MyStackGroup
&RetainStacks=false
&<Common request parameters>

Sample success responses

XML format

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

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

JSON format

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

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

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 in the stack group. name indicates the name of the stack group.