DeleteStack - Resource Orchestration Service - Alibaba Cloud Documentation Center

Deletes a stack. You can specify whether to retain resources.。

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ros:DeleteStack	delete	*stack `acs:ros:{#regionId}:{#accountId}:stack/{#stackId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
StackId	string	Yes	The ID of the stack.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
RetainAllResources	boolean	No	Specifies whether to retain all resources in the stack. Valid values: true false (default)	false
RegionId	string	Yes	The region ID of the stack. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
RamRoleName	string	No	The name of the RAM role. Resource Orchestration Service (ROS) assumes the RAM role to create the stack and uses the credentials of the role to call the APIs of Alibaba Cloud services. ROS assumes the role to perform operations on the stack. If you have permissions to perform operations on the stack but do not have permissions to use the RAM role, ROS still assumes the RAM role. You must make sure that the least privileges are granted to the RAM role. If you leave this parameter empty when you call the DeleteStack operation, ROS cannot assume the existing RAM role that is associated with the stack. If you want ROS to assume a RAM role, you must specify this parameter. If no RAM roles are available, ROS uses a temporary credential that is generated from the credentials of your account. The name of the RAM role can be up to 64 bytes in length.	test-role
RetainResources	array	No	The resources that you want to retain.
	string	No	The names of the resources that you want to retain.	my_disk
DeleteOptions	array	No	The options for deleting the stack.
	string	No	The option for deleting the stack. Valid values: Null (default): When you delete the stack, subscription resources are ignored. ThrowErrorWithSubscriptionResources: When you delete the stack, an error is reported if subscription resources exist.	["ThrowErrorWithSubscriptionResources"]
Parallelism	long	No	The maximum number of concurrent operations that can be performed on resources. By default, this parameter is empty. You can set this parameter to an integer that is greater than or equal to 0. Note If you set this parameter to an integer that is greater than 0, the integer is used. If you set this parameter to 0 or leave this parameter empty, no limit is imposed on ROS stacks. However, the default value in Terraform is used for Terraform stacks. In most cases, the default value in Terraform is 10. If you set this parameter to a specific value, ROS associates the value with the stack. The value affects subsequent operations on the stack, such as an update operation.	1

Response parameters

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

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-06-21	The request parameters of the API has changed	View Change Details
2023-03-30	The request parameters of the API has changed	View Change Details