All Products
Search
Document Center

CloudOps Orchestration Service:ACS-ESS-LifeCycleCreateNetworkInterfaceAndEipAndAttachToInstance

Last Updated:Jan 13, 2025

Template name

ACS-ESS-LifeCycleCreateNetworkInterfaceAndEipAndAttachToInstance

Execute Now

Template description

Uses a lifecycle hook to create elastic network interfaces (ENIs) and elastic IP addresses (EIPs) and associate the ENIs and EIPs with Elastic Compute Service (ECS) instances. After the ENIs are associated with the ECS instances, you must manually configure the ENIs for instances that do not use one of the following images: CentOS 7.3 64-bit and later, CentOS 6.8 64-bit and later, and Windows Server 2008 R2 and later. For more information, visit https://help.aliyun.com/document_detail/56955.html. This template supports only scale-out events.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter

Description

Type

Required

Default value

Limit

internetChargeType

The billing method of the EIPs.

String

No

PayByBandwidth

bandwidth

The peak bandwidth of the EIPs.

Number

No

5

regionId

The region ID.

String

No

${regionId}

instanceIds

The IDs of the ECS instances.

List

No

['${instanceIds}']

lifecycleHookId

The lifecycle hook ID.

String

No

${lifecycleHookId}

lifecycleActionToken

The token of a specific scaling activity that is associated with the instances.

String

No

${lifecycleActionToken}

rateControl

The rate control settings.

Json

No

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

OOSAssumeRole

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

String

No

OOSServiceRole

Output parameters

None

Policy that is required to execute the template

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "ecs:AllocateEipAddress",
                "ecs:AssociateEipAddress",
                "ecs:AttachNetworkInterface",
                "ecs:CreateNetworkInterface",
                "ecs:DeleteNetworkInterface",
                "ecs:DescribeEipAddresses",
                "ecs:DescribeInstances",
                "ecs:DescribeInvocationResults",
                "ecs:DescribeInvocations",
                "ecs:DescribeNetworkInterfaces",
                "ecs:DetachNetworkInterface",
                "ecs:ReleaseEipAddress",
                "ecs:RunCommand"
            ],
            "Resource": "*",
            "Effect": "Allow"
        },
        {
            "Action": [
                "ess:CompleteLifecycleAction"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

References

ACS-ESS-LifeCycleCreateNetworkInterfaceAndEipAndAttachToInstance

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: Use lifecycleHook to create NetworkInterface and EIP and attach them to the instance, The NetworkInterface currently only needs to be configured on CentOS 7.3 64-bit, CentOS 6.8 64-bit, Window Server 2008 R2 and higher versions, and other images, please refer to the official document for configure NetworkInterFace https://help.aliyun.com/document_detail/56955. html(only supports elastic expansion activities)
  zh-cn: 使用生命周期挂钩批量创建弹性网卡与弹性IP并将其绑定到实例上,弹性网卡目前仅在CentOS 7.3 64位、CentOS6.8 64位、Window Server 2008 R2及更高版本镜像无需配置,其它镜像请参考官方文档配置弹性网卡https://help.aliyun.com/document_detail/56955.html(仅支持弹性扩张活动)
  name-en: ACS-ESS-LifeCycleCreateNetworkInterfaceAndEipAndAttachToInstance
  name-zh-cn: 使用生命周期挂钩创建弹性网卡与EIP并绑定到实例上
  categories:
    - elastic_manage
Parameters:
  internetChargeType:
    Label:
      en: InternetChargeType
      zh-cn: EIP的计量方式
    Description:
      en: EIP measurement method
      zh-cn: EIP的计量方式(PayByBandwidth:按带宽计费,PayByTraffic:按流量计费)
    Type: String
    AllowedValues:
      - PayByBandwidth
      - PayByTraffic
    Default: PayByBandwidth
  bandwidth:
    Label:
      en: Bandwidth
      zh-cn: EIP的带宽峰值
    Description:
      en: Peak bandwidth of eip, unit: Mbps
      zh-cn: EIP的带宽峰值(Mbps)
    Type: Number
    Default: 5
  regionId:
    Label:
      en: RegionId
      zh-cn: 地域ID
    Description:
      en: The ID of region
      zh-cn: '地域ID,请使用弹性伸缩系统默认值 ${regionId}'
    Type: String
    Default: '${regionId}'
  instanceIds:
    Label:
      en: InstanceIds
      zh-cn: ECS实例ID列表
    Description:
      en: The ID list of the ECS instance
      zh-cn: 'ECS实例ID列表,请使用弹性伸缩系统默认值 ["${instanceId}"]'
    Type: List
    Default:
      - '${instanceIds}'
  lifecycleHookId:
    Label:
      en: LifecycleHookId
      zh-cn: 生命周期挂钩ID
    Description:
      en: The ID of the lifecycle hook
      zh-cn: '生命周期挂钩ID,请使用弹性伸缩系统默认值 ${lifecycleHookId}'
    Type: String
    Default: '${lifecycleHookId}'
  lifecycleActionToken:
    Label:
      en: LifecycleActionToken
      zh-cn: 实例关联的特定伸缩活动的令牌
    Description:
      en: The token that indicates a specific scaling activity associated with an instance
      zh-cn: '实例关联的特定伸缩活动的令牌,请使用弹性伸缩系统默认值 ${lifecycleActionToken}'
    Type: String
    Default: '${lifecycleActionToken}'
  rateControl:
    Label:
      en: RateControl
      zh-cn: 速率控制
    Type: Json
    AssociationProperty: RateControl
    Default:
      Mode: Concurrency
      MaxErrors: 0
      Concurrency: 5
  OOSAssumeRole:
    Label:
      en: OOSAssumeRole
      zh-cn: OOS扮演的RAM角色
    Type: String
    Default: OOSServiceRole
RamRole: '{{ OOSAssumeRole }}'
Tasks:
  - Name: createNetWorkInterfaceAndEipAndAttachToInstance
    Action: 'ACS::ECS::CreateNetworkInterfaceAndEipAndAttachToInstance'
    OnSuccess: CompleteLifecycleActionForContinue
    OnError: CompleteLifecycleActionForAbandon
    Description:
      en: Create network interface and eip and attach to instace
      zh-cn: 创建弹性网卡与弹性IP并将其绑定到实例上
    Properties:
      regionId: '{{ regionId }}'
      internetChargeType: '{{ internetChargeType }}'
      bandwidth: '{{ bandwidth }}'
      instanceId: '{{ ACS::TaskLoopItem }}'
    Loop:
      RateControl: '{{ rateControl }}'
      Items: '{{ instanceIds }}'
  - Name: CompleteLifecycleActionForContinue
    Action: 'ACS::ExecuteAPI'
    Description:
      en: Modify lifecycle action for continue
      zh-cn: 修改伸缩活动的等待状态为继续完成
    OnSuccess: 'ACS::END'
    Properties:
      Service: ESS
      API: CompleteLifecycleAction
      Parameters:
        RegionId: '{{ regionId }}'
        LifecycleHookId: '{{ lifecycleHookId }}'
        LifecycleActionToken: '{{ lifecycleActionToken }}'
        LifecycleActionResult: CONTINUE
  - Name: CompleteLifecycleActionForAbandon
    Action: 'ACS::ExecuteAPI'
    Description:
      en: Complete lifecycle action for Abandon
      zh-cn: 修改伸缩活动的等待状态为弃用
    Properties:
      Service: ESS
      API: CompleteLifecycleAction
      Parameters:
        RegionId: '{{ regionId }}'
        LifecycleHookId: '{{ lifecycleHookId }}'
        LifecycleActionToken: '{{ lifecycleActionToken }}'
        LifecycleActionResult: ABANDON