Call CancelStackOperation to cancel stack operations - Resource Orchestration Service - Alibaba Cloud - Resource Orchestration Service

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:CancelStackOperation

delete

*Stack

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

None

Request parameters

Parameter	Type	Required	Description	Example
StackId	string	Yes	The stack ID.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
RegionId	string	Yes	The region ID of the stack. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
CancelType	string	No	The method that you want to use to cancel the operations. Valid values: Quick: cancels the operations on the stack at the earliest opportunity. In this case, Resource Orchestration Service (ROS) stops scheduling new resources and stops running resources at the earliest opportunity. If you use this method, the resource status may become invalid and subsequent stack operations may be affected. Safe (default): cancels the operations on the stack in a secure manner. In this case, ROS stops scheduling new resources and waits for running resources to be stopped.	Safe
AllowedStackOperations	array	No	The operations that you want to cancel on the stack.
	string	No	The operation N that you want to cancel on the stack. Valid values: CREATE: creates a stack, or continues to create a stack from where the creation operation is stopped. UPDATE: updates a stack. IMPORT_UPDATE: creates a stack by importing resources. IMPORT_UPDATE: updates a stack by importing resources. DELETE: deletes a stack. NOT_ROLLBACK (default): all types of non-rollback operations, including CREATE, UPDATE, IMPORT_CREATE, IMPORT_UPDATE, and DELETE. If you cancel a rollback operation on a stack, the stack status may become invalid and subsequent stack operations may be affected. We recommend that you do not cancel rollback operations. CREATE_ROLLBACK: rolls back resources after a stack fails to be created. ROLLBACK: rolls back resources after a stack fails to be updated. IMPORT_CREATE_ROLLBACK: rolls back resources after a stack fails to be created by using imported resources. IMPORT_UPDATE_ROLLBACK: rolls back resources after a stack fails to be updated by using imported resources. ALL: all types of operations, including CREATE, UPDATE, IMPORT_CREATE, IMPORT_UPDATE, DELETE, CREATE_ROLLBACK, ROLLBACK, IMPORT_CREATE_ROLLBACK, and IMPORT_UPDATE_ROLLBACK. Valid values of N: 1 to 10.	NOT_ROLLBACK

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	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.