全部產品
Search
文件中心

Resource Orchestration Service:ALIYUN::VPC::EIP

更新時間:Jun 19, 2024

ALIYUN::VPC::EIP類型用於申請Elastic IP Address(Elastic IP Address,簡稱EIP)。

文法

{
  "Type": "ALIYUN::VPC::EIP",
  "Properties": {
    "DeletionProtection": Boolean,
    "Name": String,
    "Tags": List,
    "Isp": String,
    "Netmode": String,
    "Period": Number,
    "ResourceGroupId": String,
    "AutoPay": Boolean,
    "InstanceChargeType": String,
    "PricingCycle": String,
    "Bandwidth": Number,
    "InternetChargeType": String,
    "Description": String,
    "SecurityProtectionTypes": List,
    "PublicIpAddressPoolId": String,
    "Zone": String
  }
}

屬性

屬性名稱

類型

必須

允許更新

描述

約束

DeletionProtection

Boolean

是否開啟刪除保護功能。

取值:

  • true:開啟刪除保護功能。

  • false(預設值):不開啟刪除保護功能。

Name

String

EIP的名稱。

長度為2~128個字元。以英文字母開頭,不能以http://https://開頭。可包含英文字母、數字、半形句號(.)、底線(_)和短劃線(-)。

ResourceGroupId

String

資源群組ID。

Netmode

String

網路類型。

取值:public,表示公網。

Bandwidth

Number

EIP的頻寬值。

如果不指定,則取預設值5 Mbps。

InternetChargeType

String

EIP的計費方式。

取值:

  • PayByBandwidth(預設值):按頻寬計費。

  • PayByTraffic:按流量計費。

InstanceChargeType

String

EIP的付費方式。

取值:

  • Prepaid:預付費。

  • Postpaid(預設值):後付費。

PricingCycle

String

預付費的計費周期。

取值:

  • Month(預設值):月付型。

  • Year:按年付費。

說明

InstanceChargeType取值為Prepaid時,PricingCycle必選。

Period

Number

購買時間長度。

取值:

  • 選擇月付型時,取值範圍:1~9。

  • 選擇按年付費時,取值範圍:1~3。

預設值:1。

說明

InstanceChargeType取值為Prepaid時,Period必選。

AutoPay

Boolean

是否開啟自動付費。

取值:

  • false:不開啟自動付費,產生訂單後需要到訂單中心完成支付。

    關於訂單中心的更多資訊,請參見訂單中心

  • true(預設值):開啟自動付費,自動支付訂單。

說明

InstanceChargeType取值為Prepaid時,AutoPay必選。

Isp

String

線路類型。

取值:

  • BGP(預設值):BGP(多線)線路。

  • BGP_PRO:BGP(多線)精品線路。

目前,全部地區都支援BGP(多線)線路EIP,僅中國香港地區支援BGP(多線)精品線路EIP。

Description

String

EIP的描述資訊。

長度為2~256個字元。以英文字母開頭,不能以http://https://開頭。

Tags

List

標籤。

最多設定20個標籤,每個標籤由索引值對組成。標籤值可以為空白。

更多資訊,請參見Tags文法Tags屬性

SecurityProtectionTypes

List

安全防護層級。

取值:

  • 當該參數配置為空白時,預設為DDoS防護(基礎版)。

  • 當該參數配置為AntiDDoS_Enhanced時,表示為DDoS防護(增強版)。

說明

您最多可以設定10個安全防護層級。

PublicIpAddressPoolId

String

IP位址集區ID。

EIP將從該IP位址集區中分配,IP位址集區僅對通過試用申請的使用者可見。如需使用,請提交工單

Zone

String

Elastic IP Address可用分區。

Tags文法

"Tags": [
  {
    "Key": String,
    "Value": String
  }
]  

Tags屬性

屬性名稱

類型

必須

允許更新

描述

約束

Key

String

標籤鍵。

長度為1~128個字元,不能以aliyunacs:開頭,不能包含http://https://

Value

String

標籤值。

長度為0~128個字元,不能以aliyunacs:開頭,不能包含http://https://

傳回值

Fn::GetAtt

  • EipAddress:分配的EIP。

  • AllocationId:EIP的執行個體ID。

  • OrderId:訂單號,僅InstanceChargeType取值為Prepaid時返回。

  • Isp:線路類型。

樣本

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  ElasticIp:
    Type: ALIYUN::VPC::EIP
    Properties:
      InstanceChargeType: Postpaid
      Name: TestEIP
      InternetChargeType: PayByBandwidth
      Netmode: public
      Bandwidth: 5
Outputs:
  Isp:
    Description: The line type.
    Value:
      Fn::GetAtt:
        - ElasticIp
        - Isp
  AllocationId:
    Description: ID that Aliyun assigns to represent the allocation of the address for use with VPC. Returned only for VPC elastic IP addresses.
    Value:
      Fn::GetAtt:
        - ElasticIp
        - AllocationId
  EipAddress:
    Description: IP address of created EIP.
    Value:
      Fn::GetAtt:
        - ElasticIp
        - EipAddress
  OrderId:
    Description: Order ID of prepaid EIP instance.
    Value:
      Fn::GetAtt:
        - ElasticIp
        - OrderId

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "ElasticIp": {
      "Type": "ALIYUN::VPC::EIP",
      "Properties": {
        "InstanceChargeType": "Postpaid",
        "Name": "TestEIP",
        "InternetChargeType": "PayByBandwidth",
        "Netmode": "public",
        "Bandwidth": 5
      }
    }
  },
  "Outputs": {
    "Isp": {
      "Description": "The line type.",
      "Value": {
        "Fn::GetAtt": [
          "ElasticIp",
          "Isp"
        ]
      }
    },
    "AllocationId": {
      "Description": "ID that Aliyun assigns to represent the allocation of the address for use with VPC. Returned only for VPC elastic IP addresses.",
      "Value": {
        "Fn::GetAtt": [
          "ElasticIp",
          "AllocationId"
        ]
      }
    },
    "EipAddress": {
      "Description": "IP address of created EIP.",
      "Value": {
        "Fn::GetAtt": [
          "ElasticIp",
          "EipAddress"
        ]
      }
    },
    "OrderId": {
      "Description": "Order ID of prepaid EIP instance.",
      "Value": {
        "Fn::GetAtt": [
          "ElasticIp",
          "OrderId"
        ]
      }
    }
  }
}