All Products
Search

This Product

    Resource Orchestration Service:DeleteStackInstances

    Document Center

    Resource Orchestration Service:DeleteStackInstances

    Last Updated:Dec 19, 2025

    Deletes stack instances from specified accounts and regions. You can choose to retain the resources.

    Operation description

    This topic provides an example of how to delete a stack instance from the MyStackGroup stack group. The stack group uses self-managed permissions and is in the China (Hangzhou) region. This example deletes the stack instance that is deployed in the China (Beijing) region for the Alibaba Cloud account 151266687691****.

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

    delete

    *StackInstance

    acs:ros:{#regionId}:{#accountId}:stackinstance/{#StackGroupName}/{#StackInstanceAccountId}/{#StackInstanceRegionId}

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    RegionId

    string

    Yes

    The region ID of the stack group. Call the DescribeRegions operation to query the most recent list of Alibaba Cloud regions.

    cn-hangzhou

    StackGroupName

    string

    Yes

    The name of the stack group. The name must be unique within a region.
    The name can be up to 255 characters long. It must start with a letter or a digit and can contain letters, digits, hyphens (-), and underscores (_).

    MyStackGroup

    AccountIds

    array

    No

    The IDs of the accounts from which to delete stack instances. This parameter applies only to stack groups that use self-managed permissions. You can specify up to 50 account IDs.

    ["151266687691****"]

    string

    No

    The IDs of the accounts from which to delete stack instances. This parameter applies only to stack groups that use self-managed permissions. You can specify up to 50 account IDs.

    ["151266687691****","141261387191****"]

    RegionIds

    array

    Yes

    The IDs of the regions where the stack instances are deployed. You can specify up to 20 region IDs.

    ["cn-hangzhou", "cn-beijing"]

    string

    No

    The IDs of the regions where the stack instances are deployed. You can specify up to 20 region IDs.

    ["cn-hangzhou","cn-beijing"]

    RetainStacks

    boolean

    Yes

    Specifies whether to retain the stacks.

    Valid values:

    • true: The stacks are retained.

    • false: The stacks are deleted.

    false

    ClientToken

    string

    No

    A client token that is used to ensure the idempotence of the request. You can use your client to generate the token, but you must make sure that the token is unique among different requests.
    The token can be up to 64 characters long and can contain letters, digits, hyphens (-), and underscores (_).
    For more information, see How to ensure idempotence.

    123e4567-e89b-12d3-a456-42665544****

    OperationDescription

    string

    No

    The description of the operation to delete stack instances.

    The description can be 1 to 256 characters long.

    Delete stack instances in hangzhou and beijing

    OperationPreferences

    object

    No

    The preferences for the operation to delete stack instances.

    This parameter contains the following subparameters:

    • {"FailureToleranceCount": N}

      The number of accounts in each region for which the deletion of stack instances can fail. If the number of failures in a region exceeds this value, the operation stops in that region. If the operation stops in one region, it does not continue in other regions.

      The value of N must be an integer from 0 to 20.

      If you do not specify FailureToleranceCount, the default value is 0.

    • {"FailureTolerancePercentage": N}

      The percentage of accounts in each region for which the deletion of stack instances can fail. If the percentage of failures in a region exceeds this value, the operation stops in that region.

      The value of N must be an integer from 0 to 100. If the calculated percentage is not an integer, ROS rounds it down to the nearest integer.

      If you do not specify FailureTolerancePercentage, the default value is 0.

    • {"MaxConcurrentCount": N}

      The maximum number of accounts in each region for which stack instances can be deleted at the same time.

      The value of N must be an integer from 1 to 20.

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

    • {"MaxConcurrentPercentage": N}

      The maximum percentage of accounts in each region for which stack instances can be deleted at the same time.

      The value of N must be an integer from 1 to 100. If the calculated percentage is not an integer, ROS rounds it down to the nearest integer.

      If you do not specify MaxConcurrentPercentage, the default value is 1.

    • {"RegionConcurrencyType": N} The concurrency model for deleting stack instances in different regions. Valid values:

      • SEQUENTIAL (default): Deletes stack instances in each specified region sequentially. At any given time, the operation deletes stack instances in only one region.

      • PARALLEL: Deletes stack instances in all specified regions in parallel.

    Separate multiple parameters with commas (,).

    Note

    • You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage.

    • You cannot specify both FailureToleranceCount and FailureTolerancePercentage.

    {"FailureToleranceCount": 1, "MaxConcurrentCount": 2}

    DeploymentTargets

    object

    No

    The deployment targets from which to delete stack instances. This parameter applies only to stack groups that use service-managed permissions.

    RdFolderIds

    array

    No

    The IDs of folders in the resource directory. You can specify up to 20 folder IDs.

    Stack instances are deleted from all member accounts in the specified folders. If you specify the Root folder, stack instances are deleted from all member accounts in your resource directory.

    Note

    You can find the folder IDs on the Overview page in the Resource Management console. For more information, see View the basic information of a folder.

    string

    No

    The IDs of folders in the resource directory. You can specify up to 20 folder IDs.

    Stack instances are deleted from all member accounts in the specified folders. If you specify the Root folder, stack instances are deleted from all member accounts in your resource directory.

    Note

    You can find the folder IDs on the Overview page in the Resource Management console. For more information, see View the basic information of a folder.

    ["fd-4PvlVLOL8v"]

    AccountIds

    array

    No

    The IDs of member accounts in the resource directory. You can specify up to 30 member account IDs.

    Note

    You can find the member account IDs on the Overview page in the Resource Management console. For more information, see View the details of a member.

    string

    No

    The IDs of member accounts in the resource directory. You can specify up to 30 member account IDs.

    Note

    You can find the member account IDs on the Overview page in the Resource Management console. For more information, see View the details of a member.

    ["151266687691****","141261387191****"]

    For more information about common request parameters, see Common parameters.

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    14A07460-EBE7-47CA-9757-12CC4761D47A

    OperationId

    string

    The operation ID.

    6da106ca-1784-4a6f-a7e1-e723863d****

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.