ACS-ESS-LifeCycleAllocateEipAddressAndAttachToInstance.json

{
  "FormatVersion": "OOS-2019-06-01",
  "Description": {
    "en": "Use lifecycleHook to create EIP and attach them to the instance(only supports elastic expansion activities)",
    "zh-cn": "使用生命周期挂钩批量创建弹性IP并将其绑定到实例上(仅支持弹性扩张活动)",
    "name-en": "ACS-ESS-LifeCycleAllocateEipAddressAndAttachToInstance",
    "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}"
      ]
    },
    "eipTags": {
      "Label": {
        "en": "EipTags",
        "zh-cn": "EIP标签"
      },
      "Description": {
        "en": "The tags for EIP(format:[{\"Key\":\"test1\",\"Value\":\"test1\"},{\"Key\":\"test2\",\"Value\":\"test2\"}....]).",
        "zh-cn": "EIP的标签（输入格式：[{\"Key\":\"test1\",\"Value\":\"test1\"},{\"Key\":\"test2\",\"Value\":\"test2\"}....]）"
      },
      "Type": "Json",
      "Default": [
        {
          "Key": "oos_generate",
          "Value": "{{ACS::ExecutionId}}"
        }
      ]
    },
    "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": "createEipAndAttachToInstance",
      "Action": "ACS::ECS::AllocateEipAddressAndAttachToInstance",
      "OnSuccess": "CompleteLifecycleActionForContinue",
      "OnError": "CompleteLifecycleActionForAbandon",
      "Description": {
        "en": "Create the eip and attach to instace",
        "zh-cn": "创建弹性IP并将其绑定到实例上"
      },
      "Properties": {
        "regionId": "{{ regionId }}",
        "internetChargeType": "{{ internetChargeType }}",
        "bandwidth": "{{ bandwidth }}",
        "instanceId": "{{ ACS::TaskLoopItem }}",
        "tags": "{{ eipTags }}"
      },
      "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"
        }
      }
    }
  ]
}