調用ALIYUN::ECS::NetworkInterface建立一個彈性網卡 -

ALIYUN::ECS::NetworkInterface類型用於建立一個彈性網卡（ENI）。

文法

{
  "Type": "ALIYUN::ECS::NetworkInterface",
  "Properties": {
    "Description": String,
    "SecurityGroupId": String,
    "PrimaryIpAddress": String,
    "ResourceGroupId": String,
    "VSwitchId": String,
    "NetworkInterfaceName": String,
    "Tags": List,
    "SecurityGroupIds": List,
    "PrivateIpAddresses": List,
    "SecondaryPrivateIpAddressCount": Integer,
    "Ipv6Addresses": List,
    "QueueNumber": Integer,
    "NetworkInterfaceTrafficMode": String,
    "Ipv6AddressCount": Integer,
    "Ipv6Prefixes": List,
    "Ipv4Prefixes": List,
    "Ipv4PrefixCount": Integer,
    "TxQueueSize": Integer,
    "DeleteOnRelease": Boolean,
    "Ipv6PrefixCount": Integer,
    "RxQueueSize": Integer
  }
}

屬性

屬性名稱	類型	必須	允許更新	描述	約束
ResourceGroupId	String	否	是	資源群組ID。	您可以調用ListResourceGroups查詢資源群組ID。
SecurityGroupId	String	否	是	安全性群組ID。	安全性群組和彈性網卡必須在同一個專用網路中。說明不支援同時指定SecurityGroupId和SecurityGroupIds。
VSwitchId	String	是	否	交換器ID。	無
Description	String	否	是	彈性網卡的描述資訊。	長度為2~256個字元，不能以`http://`和`https://`開頭。
NetworkInterfaceName	String	否	是	彈性網卡的名稱。	長度為2~128個字元。必須以英文字母或漢字開頭，不能以`http://`和`https://`開頭。可包含英文字母、漢字、數字、半形冒號（:）、底線（_）和短劃線（-）。
PrimaryIpAddress	String	否	否	彈性網卡的主私人IP地址。	指定IP地址必須是所屬交換器位址區段內的空閑地址，不指定則預設隨機分配該交換器中的空閑地址。
SecondaryPrivateIpAddressCount	Integer	否	否	輔助私人IP地址數量。	無
Tags	List	否	是	標籤。	最多支援添加20個標籤。更多資訊，請參見Tags屬性。
SecurityGroupIds	List	否	是	一個或多個安全性群組ID。	安全性群組和彈性網卡必須在同一個專用網路中。說明不支援同時指定SecurityGroupId和SecurityGroupIds。
PrivateIpAddresses	List	否	否	從彈性網卡所屬交換器的空閑IP地址中選擇一個或多個輔助私人IP地址。	可以綁定的IP地址數量的取值範圍：彈性網卡處於可用（Available）狀態：1~10。彈性網卡處於已綁定（InUse）狀態：受到執行個體規格限制。更多資訊，請參見執行個體規格類型系列。
Ipv6Addresses	List	否	否	為彈性網卡指定一個或多個IPv6地址。	支援設定最多10個IPv6地址。說明如果您需要為彈性網卡設定IPv6地址，則必須設定`Ipv6Addresses`或者`Ipv6AddressCount`的其中一個，但不能同時設定這兩個參數。
QueueNumber	Integer	否	否	彈性網卡隊列數。	取值範圍：1~2048 附加彈性網卡時，該值必須少於執行個體規格支援單塊網卡的最大隊列數。執行個體規格的單塊網卡最大隊列數可以通過DescribeInstanceTypes介面查詢`Max imumQueueNumberPerEni`欄位。預設值：空。在附加時會採用執行個體規格的彈性網卡預設隊列數，執行個體規格的彈性網卡預設隊列數可以通過DescribeInstanceTypes介面查詢`SecondaryEniQueueNumber`欄位。
NetworkInterfaceTrafficMode	String	否	否	彈性網卡的通訊模式。	取值： Standard：使用TCP通訊模式。 HighPerformance：開啟ERI（Elastic RDMA Interface）介面，使用RDMA通訊模式。說明 HighPerformance參數值只支援RDMA增強型執行個體規格類型系列c7re，且RDMA模式的彈性網卡數量不能超過該執行個體規格類型系列的限制。c7re正在華北2（北京）可用性區域K進行邀測。更多資訊，請參見執行個體規格類型系列。
Ipv6AddressCount	Integer	否	否	為彈性網卡指定隨機產生的IPv6地址數量。	取值範圍：1~10。說明如果您需要為彈性網卡設定IPv6地址，則必須設定`Ipv6Addresses`或者`Ipv6AddressCount`的其中一個，但不能同時設定這兩個參數。
Ipv6Prefixes	List	否	否	IPv6地址首碼。	無
Ipv4Prefixes	List	否	否	IPv4 IP地址首碼。	無
Ipv4PrefixCount	Integer	否	否	為彈性網卡指定一個或多個IPv4首碼。	取值範圍：1~10。說明如果您需要為彈性網卡設定 IPv4 首碼，則必須設定 Ipv4Prefixes 或者 Ipv4PrefixCount 的其中一個，但不能同時設定這兩個參數。
TxQueueSize	Integer	否	是	彈性網卡出方向隊列深度。	您需要注意：網卡的出方向隊列深度必須和入方向隊列深度相等。取值範圍：8192~16384，且必須為2的冪。較大的出方向隊列深度可以提升出方向的輸送量，但會佔用更多的記憶體。
DeleteOnRelease	Boolean	否	是	釋放執行個體時是否保留網卡。	取值範圍： true：不保留。 false：保留。
Ipv6PrefixCount	Integer	否	否	為彈性網卡指定一個或多個 IPv6 首碼。	取值範圍：1~10。說明如果您需要為彈性網卡設定IPv6首碼，則必須設定Ipv6Prefixes或者Ipv6PrefixCount的其中一個，但不能同時設定這兩個參數。
RxQueueSize	Integer	否	是	彈性網卡入方向隊列深度。	您需要注意：網卡的入方向隊列深度必須和出方向隊列深度相等。取值範圍：8192~16384，且必須為2的冪。較大的入方向隊列深度可以提升入方向的輸送量，但會佔用更多的記憶體。

Tags文法

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

Tags屬性

屬性名稱	類型	必須	允許更新	描述	約束
Key	String	是	否	標籤鍵。	長度為1~128個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或`https://` 。
Value	String	否	否	標籤值。	長度為0~128個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或`https://` 。

傳回值

Fn::GetAtt

NetworkInterfaceId：彈性網卡ID。
MacAddress：彈性網卡的MAC地址。
PrivateIpAddress：彈性網卡的私人IP地址。
SecondaryPrivateIpAddresses：彈性網卡的輔助私人IP地址。

樣本

`YAML`格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  SecurityGroupId:
    Type: String
    AssociationProperty: ALIYUN::ECS::SecurityGroup::SecurityGroupId
    Label:
      zh-cn: 安全性群組ID
      en: Security Group ID
  VSwitchId:
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    Type: String
    Label:
      zh-cn: 網路交換器ID
      en: VSwitch ID
Resources:
  EniInstance:
    Type: ALIYUN::ECS::NetworkInterface
    Properties:
      SecurityGroupId:
        Ref: SecurityGroupId
      VSwitchId:
        Ref: VSwitchId
      NetworkInterfaceName: TestNetworkInterface
Outputs:
  PrivateIpAddress:
    Description: The primary private ip address of your Network Interface.
    Value:
      Fn::GetAtt:
        - EniInstance
        - PrivateIpAddress
  SecondaryPrivateIpAddresses:
    Description: The secondary private IP addresses of your Network Interface.
    Value:
      Fn::GetAtt:
        - EniInstance
        - SecondaryPrivateIpAddresses
  MacAddress:
    Description: The MAC address of your Network Interface.
    Value:
      Fn::GetAtt:
        - EniInstance
        - MacAddress
  NetworkInterfaceId:
    Description: ID of your Network Interface.
    Value:
      Fn::GetAtt:
        - EniInstance
        - NetworkInterfaceId

`JSON`格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SecurityGroupId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::SecurityGroup::SecurityGroupId",
      "Label": {
        "zh-cn": "安全性群組ID",
        "en": "Security Group ID"
      }
    },
    "VSwitchId": {
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "Type": "String",
      "Label": {
        "zh-cn": "網路交換器ID",
        "en": "VSwitch ID"
      }
    }
  },
  "Resources": {
    "EniInstance": {
      "Type": "ALIYUN::ECS::NetworkInterface",
      "Properties": {
        "SecurityGroupId": {
          "Ref": "SecurityGroupId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "NetworkInterfaceName": "TestNetworkInterface"
      }
    }
  },
  "Outputs": {
    "PrivateIpAddress": {
      "Description": "The primary private ip address of your Network Interface.",
      "Value": {
        "Fn::GetAtt": [
          "EniInstance",
          "PrivateIpAddress"
        ]
      }
    },
    "SecondaryPrivateIpAddresses": {
      "Description": "The secondary private IP addresses of your Network Interface.",
      "Value": {
        "Fn::GetAtt": [
          "EniInstance",
          "SecondaryPrivateIpAddresses"
        ]
      }
    },
    "MacAddress": {
      "Description": "The MAC address of your Network Interface.",
      "Value": {
        "Fn::GetAtt": [
          "EniInstance",
          "MacAddress"
        ]
      }
    },
    "NetworkInterfaceId": {
      "Description": "ID of your Network Interface.",
      "Value": {
        "Fn::GetAtt": [
          "EniInstance",
          "NetworkInterfaceId"
        ]
      }
    }
  }
}

文法

屬性

Tags文法

Tags屬性

傳回值

樣本

YAML格式

JSON格式

`YAML`格式

`JSON`格式