Template name
ACS-ECS-BulkyRebootInstances
Template description
Restarts multiple Elastic Compute Service (ECS) instances at a time. This applies to scenarios in which you need to manage and restart multiple ECS instances at a time, such as system update and O&M. When you configure this template, you must specify the following parameters: regionId: the region of the ECS instances and targets: the ECS instances. After the template is executed, the IDs of the restarted ECS instances are returned.
Template type
Automated
Owner
Alibaba Cloud
Input parameters
Parameter | Description | Type | Required | Default value | Limit |
targets | The ECS instances to be restarted. | Json | Yes | ||
regionId | The region ID. | String | No | {{ ACS::RegionId }} | |
forceStop | Specifies whether to forcibly stop the 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
Parameter | Description | Type |
instanceIds | List |
Permission policy that is required to execute the template
{
"Version": "1",
"Statement": [
{
"Action": [
"ecs:DescribeInstances",
"ecs:RebootInstance"
],
"Resource": "*",
"Effect": "Allow"
}
]
}
References
For more information, see ACS-ECS-BulkyRebootInstances.yml at GitHub.
Template content
FormatVersion: OOS-2019-06-01
Description:
en: 'Bulky restarts the ECS instances, applicable to scenarios that require managing and restarting multiple ECS instances simultaneously, such as system updates and maintenance. During configuration, users need to provide the following required parameter information: Region ID (regionId), which specifies the region of the ECS instances to be restarted, and Target Instances (targets), which defines the specific ECS instances to be operated on. Upon execution, the template will return a list of the restarted instance IDs, enabling users to verify the status of the instance restart operations.'
zh-cn: the description in Chinese
name-en: Bulky Reboot Instances
name-zh-cn: the description in Chinese
categories:
- instance_manage
- application_manage
- computenest
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
forceStop:
Label:
en: ForceStop
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: rebootInstance
Action: ACS::ECS::RebootInstance
Description:
en: Restarts the ECS instances
zh-cn: the description in Chinese
Properties:
regionId: '{{ regionId }}'
instanceId: '{{ ACS::TaskLoopItem }}'
forceStop: '{{ forceStop }}'
Loop:
RateControl: '{{ rateControl }}'
Items: '{{ getInstance.instanceIds }}'
Outputs:
instanceIds:
Type: List
Value: '{{ getInstance.instanceIds }}'
Metadata:
ALIYUN::OOS::Interface:
ParameterGroups:
- Parameters:
- regionId
- targets
Label:
default:
zh-cn: the description in Chinese
en: Select Ecs Instances
- Parameters:
- forceStop
- rateControl
- OOSAssumeRole
Label:
default:
zh-cn: the description in Chinese
en: Control Options