ACS::ECS::AllocateEipAddressAndAttachToInstance.json

{
  "FormatVersion": "OOS-2019-06-01",
  "Description": {
    "name-en": "ACS::ECS::AllocateEipAddressAndAttachToInstance",
    "name-zh-cn": "创建并绑定EIP(ECS)",
    "en": "Create the eip and bind it to ECS instance",
    "zh-cn": "创建EIP并绑定到ECS实例"
  },
  "Parameters": {
    "regionId": {
      "Label": {
        "en": "RegionId",
        "zh-cn": "地域ID"
      },
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId",
      "Default": "{{ ACS::RegionId }}"
    },
    "instanceId": {
      "Label": {
        "en": "ECSInstanceId",
        "zh-cn": "ECS实例ID"
      },
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId",
      "AssociationPropertyMetadata": {
        "RegionId": "regionId"
      }
    },
    "internetChargeType": {
      "Label": {
        "en": "EIPInternetChargeType",
        "zh-cn": "EIP的计费方式"
      },
      "Type": "String",
      "AllowedValues": [
        "PayByBandwidth",
        "PayByTraffic"
      ],
      "Default": "PayByBandwidth"
    },
    "bandwidth": {
      "Label": {
        "en": "EIPBandwidth",
        "zh-cn": "EIP的带宽峰值"
      },
      "Type": "Number",
      "Default": 5
    },
    "tags": {
      "Label": {
        "en": "Tags",
        "zh-cn": "标签"
      },
      "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",
      "AssociationProperty": "Tags",
      "AssociationPropertyMetadata": {
        "ShowSystem": false
      },
      "Default": [
        {
          "Key": "oos_generate",
          "Value": "{{ACS::ExecutionId}}"
        }
      ]
    },
    "ISP": {
      "Label": {
        "en": "ISP",
        "zh-cn": "EIP的线路类型"
      },
      "Type": "String",
      "AllowedValues": [
        "BGP",
        "BGP_PRO"
      ],
      "Default": "BGP"
    }
  },
  "Tasks": [
    {
      "Name": "waitInstanceReady",
      "Action": "ACS::WaitFor",
      "Delay": 15,
      "Retries": 7,
      "DelayType": "Constant",
      "Description": {
        "en": "Waits for ECS instance enter to the Running or Stopped status",
        "zh-cn": "等待ECS实例进入Running或Stopped状态"
      },
      "Properties": {
        "Service": "ECS",
        "API": "DescribeInstances",
        "Parameters": {
          "RegionId": "{{ regionId }}",
          "InstanceIds": [
            "{{ instanceId }}"
          ]
        },
        "DesiredValues": [
          "Running",
          "Stopped"
        ],
        "PropertySelector": "Instances.Instance[].Status"
      }
    },
    {
      "Name": "allocateEipAddress",
      "Action": "ACS::ExecuteAPI",
      "Description": {
        "en": "Allocates an EIP",
        "zh-cn": "获取一个弹性公网IP"
      },
      "Properties": {
        "Service": "ECS",
        "API": "AllocateEipAddress",
        "Parameters": {
          "RegionId": "{{ regionId }}",
          "InternetChargeType": "{{ internetChargeType }}",
          "Bandwidth": "{{ bandwidth }}",
          "ISP": "{{ ISP }}"
        }
      },
      "Outputs": {
        "allocationId": {
          "Type": "String",
          "ValueSelector": ".AllocationId"
        }
      }
    },
    {
      "Name": "waitEipAddressReady",
      "Action": "ACS::WaitFor",
      "Description": {
        "en": "Waits for the EIP enter to Available status",
        "zh-cn": "等待EIP进入Available状态"
      },
      "Delay": 15,
      "Retries": 7,
      "DelayType": "Constant",
      "Properties": {
        "Service": "ECS",
        "API": "DescribeEipAddresses",
        "Parameters": {
          "RegionId": "{{ regionId }}",
          "AllocationId": "{{ allocateEipAddress.allocationId }}"
        },
        "DesiredValues": [
          "Available"
        ],
        "PropertySelector": "EipAddresses.EipAddress[].Status"
      }
    },
    {
      "Name": "tagResources",
      "Action": "ACS::CheckFor",
      "Description": {
        "en": "Adds tags on EIP",
        "zh-cn": "给EIP打标签"
      },
      "OnError": "associateEipAddress",
      "Properties": {
        "Service": "VPC",
        "API": "TagResources",
        "Parameters": {
          "RegionId": "{{ regionId }}",
          "ResourceType": "EIP",
          "ResourceId": [
            "{{ allocateEipAddress.allocationId }}"
          ],
          "Tags": "{{ tags }}"
        },
        "DesiredValues": [
          true,
          false
        ],
        "PropertySelector": ".Code | not"
      },
      "Outputs": {
        "code": {
          "Type": "String",
          "ValueSelector": ".Code | not"
        }
      }
    },
    {
      "Name": "associateEipAddress",
      "Action": "ACS::ExecuteAPI",
      "Description": {
        "en": "Binds the EIP to instance",
        "zh-cn": "绑定EIP到实例"
      },
      "OnError": "unassociateEipAddress",
      "Properties": {
        "Service": "ECS",
        "API": "AssociateEipAddress",
        "Parameters": {
          "RegionId": "{{ regionId }}",
          "AllocationId": "{{ allocateEipAddress.allocationId }}",
          "InstanceId": "{{ instanceId }}"
        }
      }
    },
    {
      "Name": "waitEipAddressInUse",
      "Action": "ACS::WaitFor",
      "Description": {
        "en": "Waits for the eip util In_use",
        "zh-cn": "等待EIP到达In_use状态"
      },
      "Delay": 15,
      "Retries": 7,
      "DelayType": "Constant",
      "OnSuccess": "ACS::END",
      "OnError": "unassociateEipAddress",
      "Properties": {
        "Service": "ECS",
        "API": "DescribeEipAddresses",
        "Parameters": {
          "RegionId": "{{ regionId }}",
          "AllocationId": "{{ allocateEipAddress.allocationId }}"
        },
        "DesiredValues": [
          "InUse"
        ],
        "PropertySelector": "EipAddresses.EipAddress[].Status"
      }
    },
    {
      "Name": "unassociateEipAddress",
      "Action": "ACS::ExecuteAPI",
      "Description": {
        "en": "Unasscocaties the eip from instance",
        "zh-cn": "从实例上解绑EIP"
      },
      "OnError": "waitEipAddressAvailable",
      "Properties": {
        "Service": "ECS",
        "API": "UnassociateEipAddress",
        "Parameters": {
          "RegionId": "{{ regionId }}",
          "AllocationId": "{{ allocateEipAddress.allocationId }}",
          "InstanceId": "{{ instanceId }}"
        }
      }
    },
    {
      "Name": "waitEipAddressAvailable",
      "Action": "ACS::WaitFor",
      "Description": {
        "en": "Waits for the eip util Available",
        "zh-cn": "等待EIP到达Available状态"
      },
      "Delay": 15,
      "Retries": 7,
      "DelayType": "Constant",
      "OnError": "releaseEipAddress",
      "Properties": {
        "Service": "ECS",
        "API": "DescribeEipAddresses",
        "Parameters": {
          "RegionId": "{{ regionId }}",
          "AllocationId": "{{ allocateEipAddress.allocationId }}"
        },
        "DesiredValues": [
          "Available"
        ],
        "PropertySelector": "EipAddresses.EipAddress[].Status"
      }
    },
    {
      "Action": "ACS::ExecuteAPI",
      "Name": "releaseEipAddress",
      "Description": {
        "en": "Releases the EIP",
        "zh-cn": "释放EIP"
      },
      "Properties": {
        "Service": "ECS",
        "API": "ReleaseEipAddress",
        "Parameters": {
          "RegionId": "{{ regionId }}",
          "AllocationId": "{{ allocateEipAddress.allocationId }}"
        }
      }
    }
  ],
  "Outputs": {
    "instanceAndAllocationId": {
      "Type": "String",
      "Value": "{instanceId:{{ instanceId }}, allocationId: {{ allocateEipAddress.allocationId }}}"
    }
  }
}