ALIYUN::ECS::NetworkInterface - Resource Orchestration Service - Centro de documentación de Alibaba Cloud

El tipo ALIYUN::ECS::NetworkInterface se usa para crear una interfaz de red elástica (ENI).

Sintaxis

{
  "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
  }
}

Propiedades

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
ResourceGroupId	String	No	Sí	El ID del resource group.	Llame a la operación ListResourceGroups para consultar el ID del resource group.
SecurityGroupId	String	No	Sí	El ID del security group.	El security group y la ENI deben pertenecer a la misma virtual private cloud (VPC). Nota No puede especificar SecurityGroupId y SecurityGroupIds al mismo tiempo.
VSwitchId	String	Sí	No	El ID del vSwitch.	Ninguna.
Description	String	No	Sí	La descripción de la ENI.	La descripción debe tener entre 2 y 256 caracteres. No puede comenzar con `http://` ni con `https://`.
NetworkInterfaceName	String	No	Sí	El nombre de la ENI.	El nombre debe tener entre 2 y 128 caracteres. Debe comenzar con una letra y no puede iniciar con `http://` ni con `https://`. Admite letras, dígitos, dos puntos (:), guiones bajos (_) y guiones (-).
PrimaryIpAddress	String	No	No	La dirección IP privada principal de la ENI.	La dirección IP privada principal debe estar libre dentro del bloque CIDR del vSwitch que desea asociar a la ENI. Si deja esta propiedad vacía, se asigna automáticamente una dirección IP libre del bloque CIDR del vSwitch.
SecondaryPrivateIpAddressCount	Integer	No	No	El número de direcciones IP privadas secundarias.	Ninguna.
Tags	List	No	Sí	Las etiquetas.	Agregue hasta 20 etiquetas. Para obtener más información, consulte Tags properties.
SecurityGroupIds	List	No	Sí	Los ID de uno o más security groups.	Los security groups y la ENI deben pertenecer a la misma VPC. Nota No puede especificar SecurityGroupId y SecurityGroupIds al mismo tiempo.
PrivateIpAddresses	List	No	No	Una o más direcciones IP privadas secundarias que se asignarán a la ENI desde el bloque CIDR del vSwitch asociado.	Valores válidos para el número de direcciones IP privadas secundarias que se pueden asignar a la ENI: Si la ENI se encuentra en estado Available, los valores válidos van de 1 a 10. Si la ENI se encuentra en estado InUse, los valores válidos dependen del tipo de instancia. Para obtener más información, consulte Instance family overview.
Ipv6Addresses	List	No	No	Una o más direcciones IPv6 que se asignarán a la ENI.	Especifique hasta 10 direcciones IPv6. Nota Si desea asignar direcciones IPv6 a la ENI, especifique la propiedad `Ipv6Addresses` o `Ipv6AddressCount`, pero no ambas.
QueueNumber	Integer	No	No	El número de colas compatibles con la ENI.	Valores válidos: de 1 a 2048. Cuando asocie la ENI a una instancia, compruebe que el valor de esta propiedad sea menor que el número máximo de colas por ENI permitido para ese tipo de instancia. Para consultar el número máximo de colas por ENI del tipo de instancia, llame a la operación DescribeInstanceTypes y revise el valor devuelto por `MaximumQueueNumberPerEni`. De forma predeterminada, la propiedad QueueNumber queda vacía. Si la deja vacía al asociar la ENI a una instancia, se utiliza el número predeterminado de colas por ENI permitido para ese tipo de instancia. Para consultar este valor predeterminado, llame a la operación DescribeInstanceTypes y revise el valor devuelto por `SecondaryEniQueueNumber`.
NetworkInterfaceTrafficMode	String	No	No	El modo de comunicación de la ENI.	Valores válidos: Standard: utiliza el modo de comunicación TCP. HighPerformance: utiliza el modo de comunicación de acceso remoto directo a memoria (RDMA) con la función Elastic RDMA Interface (ERI) habilitada. Nota El valor HighPerformance solo es compatible con la familia de instancias optimizadas para RDMA c7re. El número máximo de ENI en modo RDMA que se pueden asociar a una instancia c7re depende del tipo de instancia. La familia de instancias c7re se encuentra en vista previa por invitación en Beijing Zone K. Para obtener más información, consulte Instance family overview.
Ipv6AddressCount	Integer	No	No	El número de direcciones IPv6 que se generarán de forma aleatoria para la ENI.	Valores válidos: de 1 a 10. Nota Si desea asignar direcciones IPv6 a la ENI, especifique la propiedad `Ipv6Addresses` o `Ipv6AddressCount`, pero no ambas.
Ipv6Prefixes	List	No	No	Los prefijos IPv6.	Ninguna.
Ipv4Prefixes	List	No	No	Los prefijos IPv4.	Ninguna.
Ipv4PrefixCount	Integer	No	No	El número de prefijos IPv4 que se asignarán a la ENI.	Valores válidos: de 1 a 10. Nota Si desea asignar prefijos IPv4 a la ENI, especifique la propiedad Ipv4Prefixes o Ipv4PrefixCount, pero no ambas.
TxQueueSize	Integer	No	Sí	La profundidad de la cola de transmisión (Tx) de la ENI.	Tenga en cuenta lo siguiente: La profundidad de la cola Tx de una ENI debe ser igual a la profundidad de su cola de recepción (Rx). Valores válidos: potencias de 2 en el rango de 8192 a 16384. Una mayor profundidad de la cola Tx aumenta el rendimiento de salida, pero consume más memoria.
DeleteOnRelease	Boolean	No	Sí	Indica si se conserva la ENI cuando se libera la instancia asociada.	Valores válidos: true false
Ipv6PrefixCount	Integer	No	No	El número de prefijos IPv6 que se asignarán a la ENI.	Valores válidos: de 1 a 10. Nota Si desea asignar prefijos IPv6 a la ENI, especifique la propiedad Ipv6Prefixes o Ipv6PrefixCount, pero no ambas.
RxQueueSize	Integer	No	Sí	La profundidad de la cola Rx de la ENI.	Tenga en cuenta lo siguiente: La profundidad de la cola Rx de una ENI debe ser igual a la profundidad de su cola Tx. Valores válidos: potencias de 2 en el rango de 8192 a 16384. Una mayor profundidad de la cola Rx aumenta el rendimiento de entrada, pero consume más memoria.

Sintaxis de Tags

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

Propiedades de Tags

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
Key	String	Sí	No	La clave de la etiqueta.	La clave de la etiqueta debe tener entre 1 y 128 caracteres. No puede contener `http://` ni `https://`. Tampoco puede comenzar con `aliyun` ni con `acs:`.
Value	String	No	No	El valor de la etiqueta.	El valor de la etiqueta puede tener hasta 128 caracteres. No puede contener `http://` ni `https://`. Tampoco puede comenzar con `aliyun` ni con `acs:`.

Valores de retorno

Fn::GetAtt

NetworkInterfaceId: el ID de la ENI.
MacAddress: la dirección de control de acceso a medios (MAC) de la ENI.
PrivateIpAddress: la dirección IP privada de la ENI.
SecondaryPrivateIpAddresses: las direcciones IP privadas secundarias de la ENI.
Arn: el Alibaba Cloud Resource Name (ARN).

Ejemplos

Formato `YAML`

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  SecurityGroupId:
    Type: String
    AssociationProperty: ALIYUN::ECS::SecurityGroup::SecurityGroupId
    Label:
       
      en: Security Group ID
  VSwitchId:
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    Type: String
    Label:
       
      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

Formato `JSON`

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SecurityGroupId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::SecurityGroup::SecurityGroupId",
      "Label": {
         
        "en": "Security Group ID"
      }
    },
    "VSwitchId": {
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "Type": "String",
      "Label": {
         
        "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"
        ]
      }
    }
  }
}

Sintaxis

Propiedades

Sintaxis de Tags

Propiedades de Tags

Valores de retorno

Ejemplos

Formato YAML

Formato JSON

Formato `YAML`

Formato `JSON`