All Products
Search
Document Center

CloudOps Orchestration Service:ACS-ECS-BulkyDeleteInstances

Last Updated:Jan 06, 2025

Template name

ACS-ECS-BulkyDeleteInstances

Execute Now

Template description

Releases multiple pay-as-you-go Elastic Compute Service (ECS) instances at a time. This applies to scenarios in which you need to delete multiple ECS instances at a time, such as resource release and cost optimization. When you configure this template, you must specify the following parameters: regionId: the region of the ECS instance to be deleted and targets: the ECS instances to be deleted. You can also specify the force parameter to determine whether to forcefully delete the ECS instances. After the template is executed, the IDs of the deleted ECS intances are returned.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter

Description

Type

Required

Default value

Limit

targets

The ECS instances to be released.

Json

Yes

regionId

The region ID.

String

No

{{ ACS::RegionId }}

force

Specifies whether to forcibly stop and release running ECS instances.

Boolean

No

False

rateControl

The rate control settings.

Json

No

{'Mode': 'Concurrency', 'MaxErrors': 0, 'Concurrency': 10}

OOSAssumeRole

The Resource Access Management (RAM) role that is assumed by CloudOps Orchestration Service (OOS).

String

No

""

Output parameters

None

Permission policy that is required to execute the template

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "ecs:DeleteInstance",
                "ecs:DescribeInstances"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

References

For more information, see ACS-ECS-BulkyDeleteInstances.yml at GitHub.

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: 'Bulky delete ECS postpaid instances, applicable to scenarios that require managing and deleting multiple pay-as-you-go ECS instances simultaneously, such as resource release and cost optimization. During configuration, users need to provide the following required parameter information: Region ID (regionId), which specifies the region of the ECS instances to be deleted, and Target Instances (targets), which defines the specific ECS instances to be operated on. Users can also choose whether to force delete running instances (force). Upon execution, the template will return a list of the deleted instance IDs, enabling users to verify the status of the instance deletions.'
  zh-cn: the description in Chinese
  name-en: ACS-ECS-BulkyDeleteInstances
  name-zh-cn: the description in Chinese
  categories:
    - instance_manage
Parameters:
  regionId:
    Type: String
    Label:
      en: RegionId
      zh-cn: the description in Chinese
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  targets:
    Type: Json
    Label:
      en: TargetInstance
      zh-cn: the description in Chinese
    AssociationProperty: Targets
    AssociationPropertyMetadata:
      ResourceType: ALIYUN::ECS::Instance
      RegionId: regionId
  force:
    Label:
      en: Force
      zh-cn: the description in Chinese
    Type: Boolean
    Default: false
  rateControl:
    Label:
      en: RateControl
      zh-cn: the description in Chinese
    Type: Json
    AssociationProperty: RateControl
    Default:
      Mode: Concurrency
      MaxErrors: 0
      Concurrency: 10
  OOSAssumeRole:
    Label:
      en: OOSAssumeRole
      zh-cn: the description in Chinese
    Type: String
    Default: ''
RamRole: '{{ OOSAssumeRole }}'
Tasks:
- Name: getInstance
  Description:
    en: Views the ECS instances
    zh-cn: the description in Chinese
  Action: ACS::SelectTargets
  Properties:
    ResourceType: ALIYUN::ECS::Instance
    RegionId: '{{ regionId }}'
    Filters:
      - '{{ targets }}'
  Outputs:
    instanceIds:
      Type: List
      ValueSelector: Instances.Instance[].InstanceId
- Name: deleteInstance
  Action: ACS::ExecuteAPI
  Description:
    en: Deletes ECS instance with the specified instance ID
    zh-cn: the description in Chinese
  Properties:
    Service: ECS
    API: DeleteInstance
    Parameters:
      RegionId: '{{ regionId }}'
      InstanceId: '{{ ACS::TaskLoopItem }}'
      Force: '{{ force }}'
  Loop:
    RateControl: '{{ rateControl }}'
    Items: '{{ getInstance.instanceIds }}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - force
        Label:
          default:
            zh-cn: the description in Chinese
            en: Configure Parameters
      - Parameters:
          - regionId
          - targets
        Label:
          default:
            zh-cn: the description in Chinese
            en: Select Instances
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:
            zh-cn: the description in Chinese
            en: Control Options