DeleteStackInstances - API Reference| Alibaba Cloud Documentation Center

You can call this operation to delete stack instances in a specified account and 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.
AccountIds	JSON	Yes	["123456"]	The list of target account IDs, in JSON format. A maximum of 20 accounts can be specified.
RegionId	String	Yes	cn-hangzhou	The region ID of the stack. You can call the DescribeRegions operation to query the most recent region list.
RegionIds	JSON	Yes	["cn-hangzhou", "cn-beijing"]	The list of target regions, in JSON format. A maximum of 20 regions can be specified.
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.
RetainStacks	Boolean	No	false	Specifies whether to retain the stack corresponding to the stack instance. If the stack is retained, the corresponding stack is not deleted when the stack instance is deleted from the stack group.
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	Delete stack instances in hangzhou and beijing	The description of the operation. The description describes the purpose or action of the operation. The description must be 1 to 256 characters in length.
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.

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=DeleteStackInstances
&AccountIds=["123456"]
&RegionId=cn-hangzhou
&RegionIds=["cn-hangzhou", "cn-beijing"]
&StackGroupName=MyStackGroup
&RetainStacks=false
&<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.