DeleteStack

Deletes a stack, optionally retaining resources.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ros:DeleteStack

delete

*stack

acs:ros:{#regionId}:{#accountId}:stack/{#stackId}

None

Request parameters

Parameter	Type	Required	Description	Example
StackId	string	Yes	The ID of the stack.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
RetainAllResources	boolean	No	Whether to retain all resources in the stack. Valid values: true false (default)	false
RegionId	string	Yes	The region ID of the stack. Call DescribeRegions to query available regions.	cn-hangzhou
RamRoleName	string	No	The RAM role name. ROS assumes this role to create the stack and call Alibaba Cloud service APIs. Even if you have stack operation permissions but lack RAM role permissions, ROS still assumes the role. Ensure the role follows the least-privilege principle. If empty, ROS cannot assume the existing RAM role associated with the stack. To have ROS assume a role, specify this parameter. If no RAM role is available, ROS uses a temporary credential from your account credentials. Maximum length: 64 bytes.	test-role
RetainResources	array	No	Resources to retain.	WebServer
	string	No	Names of resources to retain.	my_disk
DeleteOptions	array	No	Stack deletion options.
	string	No	Stack deletion option. Valid values: Null (default): Subscription resources are ignored during deletion. ThrowErrorWithSubscriptionResources: Returns an error if subscription resources exist.	["ThrowErrorWithSubscriptionResources"]
Parallelism	integer	No	Maximum number of concurrent resource operations. Default: empty. Accepts an integer >= 0. Note A value greater than 0 is used as-is. A value of 0 or empty imposes no limit on ROS stacks. For Terraform stacks, the Terraform default (typically 10) applies. This value persists on the stack and affects subsequent operations such as updates.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	B288A0BE-D927-4888-B0F7-B35EF84B6E6F

Examples

Success response

JSON format

{
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.