All Products
Search
Document Center

CloudOps Orchestration Service:ACS-ESS-EnableInstanceHealthCheck

Last Updated:Jan 13, 2025

Template name

ACS-ESS-EnableInstanceHealthCheck

Execute Now

Template description

Enables the health check feature for the Elastic Compute Service (ECS) instances in a scaling group.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter

Description

Type

Required

Default value

Limit

scalingGroupId

The ID of the scaling group to be modified.

String

Yes

regionId

The region ID.

String

No

{{ ACS::RegionId }}

OOSAssumeRole

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

String

No

""

Output parameters

None

Policy that is required to execute the template

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "ess:DescribeScalingGroups",
                "ess:ModifyScalingGroup"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

References

ACS-ESS-EnableInstanceHealthCheck

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: Enables health checks for ECS instances in the scaling group
  zh-cn: 开启ESS伸缩组中的ECS实例的健康检查
  name-en: ACS-ESS-EnableInstanceHealthCheck
  name-zh-cn: 开启ESS伸缩组中的ECS实例的健康检查
  categories:
    - elastic_manage
Parameters:
  regionId:
    Type: String
    Label:
      en: RegionId
      zh-cn: 地域ID
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  scalingGroupId:
    Label:
      en: ScalingGroupId
      zh-cn: 待修改伸缩组的ID
    Type: String
  OOSAssumeRole:
    Label:
      en: OOSAssumeRole
      zh-cn: OOS扮演的RAM角色
    Type: String
    Default: ''
RamRole: '{{ OOSAssumeRole }}'
Tasks:
  - Name: checkForScalingGroupAvalible
    Action: 'ACS::CheckFor'
    Description:
      en: Check weather the Scaling Group is avaliable
      zh-cn: 检查伸缩组状态是否可用
    Properties:
      Service: ESS
      API: DescribeScalingGroups
      Parameters:
        RegionId: '{{ regionId }}'
        ScalingGroupId1: '{{ scalingGroupId }}'
      DesiredValues:
        - Active
        - Inactive
      PropertySelector: ScalingGroups.ScalingGroup[].LifecycleState
  - Name: modifyScalingGroup
    Action: 'ACS::ExecuteAPI'
    Description:
      en: Modify the health check status of the ECS flex group
      zh-cn: 修改ECS伸缩组的健康检查状态
    Properties:
      Service: ESS
      API: ModifyScalingGroup
      Parameters:
        RegionId: '{{ regionId }}'
        ScalingGroupId: '{{ scalingGroupId }}'
        HealthCheckType: 'ECS'