DescribeNetworkInterfaces - Elastic Compute Service - Centro de documentación de Alibaba Cloud

Consulta los detalles de una o más interfaces de red elásticas (ENI).

Descripción de la operación

La operación DescribeNetworkInterfaces admite la paginación mediante la especificación del parámetro MaxResults o NextToken. Notas de uso:

Al consultar la primera página, configure solo MaxResults para limitar el número de entradas devueltas. El valor NextToken en la respuesta se utiliza como credencial para consultar las páginas siguientes.
Al consultar páginas siguientes, configure NextToken con el valor NextToken obtenido de la respuesta anterior y configure MaxResults para limitar el número de entradas devueltas.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

ecs:DescribeNetworkInterfaces

get

NetworkInterface

acs:ecs:{#regionId}:{#accountId}:eni/{#eniId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región. Puede llamar a DescribeRegions para consultar la lista de regiones más reciente.	cn-hangzhou
Tag	array<object>	No	Las etiquetas.
	object	No
Key	string	No	La clave de etiqueta de la tarjeta de interfaz de red (NIC). Valores válidos de N: 1 a 20.	TestKey
Value	string	No	El valor de etiqueta de la tarjeta de interfaz de red (NIC). Valores válidos de N: 1 a 20. Si utiliza una sola etiqueta para filtrar recursos, la cantidad de recursos con la etiqueta especificada no puede superar los 1,000. Si utiliza varias etiquetas para filtrar recursos, la cantidad de recursos que tienen todas las etiquetas especificadas no puede superar los 1,000. Si la cantidad de recursos supera los 1,000, llame a la operación ListTagResources para consultar los recursos.	TestValue
ResourceGroupId	string	No	El ID del grupo de recursos. Si utiliza este parámetro para filtrar recursos, la cantidad de recursos no puede superar los 1,000. Nota No se admite el filtrado por el grupo de recursos predeterminado.	rg-bp67acfmxazb4p****
VSwitchId	string	No	El ID del vSwitch de la tarjeta de interfaz de red (NIC).	vsw-bp16usj2p27htro3****
VpcId	string	No	El ID de la nube privada virtual (VPC) de la tarjeta de interfaz de red (NIC).	vpc-bp1j7w3gc1cexjqd****
PrimaryIpAddress	string	No	La dirección IP privada principal de la tarjeta de interfaz de red (NIC).	192.168..
SecurityGroupId	string	No	El ID del security group de la ENI secundaria. Para consultar información sobre una ENI secundaria por ID de security group, especifique este parámetro. Para consultar información sobre una ENI principal por ID de security group, llame a DescribeInstances y especifique el parámetro `SecurityGroupId`.	sg-bp144yr32sx6ndw****
NetworkInterfaceName	string	No	El nombre de la tarjeta de interfaz de red (NIC). El nombre debe tener entre 2 y 128 caracteres de longitud y puede contener caracteres de la categorización de letras Unicode (que incluye letras en inglés, caracteres chinos y dígitos). El nombre puede contener dos puntos (:), guiones bajos (_), puntos (.) o guiones (-).	test-eni-name
Type	string	No	El tipo de la interfaz de red elástica (ENI). Valores válidos: Primary: tarjeta de interfaz de red (NIC) principal. Secondary: ENI secundaria. Valor predeterminado: null, lo que indica que se consultan todos los tipos.	Secondary
InstanceId	string	No	El ID de la instancia a la que está conectada la tarjeta de interfaz de red (NIC).	i-bp1e2l6djkndyuli****
ServiceManaged	boolean	No	Indica si el usuario de la tarjeta de interfaz de red (NIC) es un servicio de Alibaba Cloud o un operador de red virtual (VNO).	true
Status	string	No	El estado de la tarjeta de interfaz de red (NIC). Valores válidos: Available: disponible. Attaching: conectándose. InUse: conectado. Detaching: desconectándose. Deleting: eliminándose. Valor predeterminado: null, lo que indica que se consultan todos los estados.	Available
PageNumber `deprecated`	integer	No	Nota Este parámetro está obsoleto. Utilice los parámetros MaxResults y NextToken para la paginación.	1
PageSize `deprecated`	integer	No	Nota Este parámetro está obsoleto. Utilice los parámetros MaxResults y NextToken para la paginación.	100
NextToken	string	No	El token de paginación. Configure este parámetro con el valor `NextToken` devuelto en la llamada a la API anterior. Para obtener información sobre cómo ver los datos devueltos, consulte la descripción de la operación anterior.	AAAAAdDWBF2****
MaxResults	integer	No	El número máximo de entradas por página para la paginación. Valores válidos: 10 a 500. Valor predeterminado: Si no configura este parámetro o lo establece en un valor menor que 10, el valor predeterminado es 10. Si configura este parámetro en un valor mayor que 500, el valor predeterminado es 500.	50
PrivateIpAddress	array	No	La dirección IP privada secundaria de la tarjeta de interfaz de red (NIC). Valores válidos de N: 1 a 100.	192.168..
	string	No	La dirección IP privada secundaria de la tarjeta de interfaz de red (NIC). Valores válidos de N: 1 a 100.	192.168..
NetworkInterfaceId	array	No	El ID de la tarjeta de interfaz de red (NIC). Valores válidos de N: 1 a 100.	eni-bp125p95hhdhn3ot****
	string	No	El ID de la tarjeta de interfaz de red (NIC). Valores válidos de N: 1 a 100.	eni-bp125p95hhdhn3ot****
Ipv6Address	array	No	La dirección IPv6 de la tarjeta de interfaz de red (NIC). N indica que puede especificar varias direcciones IPv6. Valores válidos de N: 1 a 100.	2408:4321:180:1701:94c7:bc38:3bfa:****
	string	No	La dirección IPv6 de la tarjeta de interfaz de red (NIC). N indica que puede especificar varias direcciones IPv6. Valores válidos de N: 1 a 100.	2408:4321:180:1701:94c7:bc38:3bfa:****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
NextToken	string	El token de paginación devuelto en esta llamada.	AAAAAdDWBF2****
PageSize	integer	El parámetro de paginación. Nota Este parámetro está quedando obsoleto. Utilice NextToken y MaxResults para la paginación.	1
PageNumber	integer	El parámetro de paginación. Nota Este parámetro está quedando obsoleto. Utilice NextToken y MaxResults para la paginación.	1
RequestId	string	El ID de la solicitud.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	El número total de interfaces de red elásticas (ENI) devueltas. Nota Cuando utiliza los parámetros `MaxResults` y `NextToken` para la paginación, el valor `TotalCount` devuelto carece de significado.	2
NetworkInterfaceSets	object
NetworkInterfaceSet	array<object>	La colección de información de la tarjeta de interfaz de red (NIC).
	array<object>
CreationTime	string	La hora de creación. La hora sigue el estándar ISO 8601 en el formato yyyy-MM-ddTHH:mm:ssZ. La hora se muestra en UTC+0.	2019-12-25T12:31:31Z
VpcId	string	El ID de la nube privada virtual (VPC) de la tarjeta de interfaz de red (NIC).	vpc-bp1j7w3gc1cexjqd****
Type	string	El tipo de la interfaz de red elástica (ENI). Valores válidos: Primary: tarjeta de interfaz de red (NIC) principal. Secondary: ENI secundaria.	Secondary
Status	string	El estado de la tarjeta de interfaz de red (NIC). Valores válidos: Available: disponible. Attaching: conectándose. InUse: conectado. Detaching: desconectándose. Deleting: eliminándose.	Available
NetworkInterfaceTrafficMode	string	El modo de comunicación de la tarjeta de interfaz de red (NIC). Valores válidos: Standard: se utiliza el modo de comunicación TCP. HighPerformance: la interfaz RDMA elástica (ERI) está habilitada y se utiliza el modo de comunicación RDMA. Nota El valor HighPerformance solo es compatible con la familia de instancias mejoradas con RDMA c7re. Actualmente, este valor solo se puede especificar en la Zona K de la región China (Beijing).	Standard
NetworkInterfaceName	string	El nombre de la tarjeta de interfaz de red (NIC).	my-eni-name
MacAddress	string	La dirección MAC de la tarjeta de interfaz de red (NIC).	00:16:3e:12::
QueuePairNumber	integer	Nota Este parámetro se encuentra en vista previa por invitación y no está disponible públicamente.	0
NetworkInterfaceId	string	El ID de la tarjeta de interfaz de red (NIC).	eni-bp125p95hhdhn3ot****
ServiceID	integer	El ID del operador de red virtual (VNO) al que pertenece la tarjeta de interfaz de red (NIC).	12345678910
InstanceId	string	El ID de la instancia a la que está conectada la tarjeta de interfaz de red (NIC). Nota Las tarjetas de interfaz de red (NIC) que son administradas y controladas por otros servicios de Alibaba Cloud no devuelven un ID de instancia.	i-bp1e2l6djkndyuli****
OwnerId	string	El ID de la cuenta propietaria de la tarjeta de interfaz de red (NIC).	123456****
ServiceManaged	boolean	Indica si el usuario de la tarjeta de interfaz de red (NIC) es un servicio de Alibaba Cloud o un operador de red virtual (VNO).	true
VSwitchId	string	El ID del vSwitch de la VPC.	vsw-bp16usj2p27htro3****
Description	string	La descripción.	DescriptionTest
ResourceGroupId	string	El ID del grupo de recursos.	rg-2ze88m67qx5z****
ZoneId	string	El ID de la zona.	cn-hangzhou-e
PrivateIpAddress	string	La dirección IP privada de la tarjeta de interfaz de red (NIC).	172.17..
QueueNumber	integer	El número de colas de la interfaz de red elástica (ENI). Si la tarjeta de interfaz de red (NIC) secundaria está en estado conectado (InUse) y no se ha modificado el número de colas, se devuelve el número de colas predeterminado para las ENI secundarias del tipo de instancia. Si se ha modificado el número de colas de la tarjeta de interfaz de red (NIC) secundaria, se devuelve el número de colas modificado. Si la tarjeta de interfaz de red (NIC) secundaria está en estado no conectado (Available) y no se ha modificado el número de colas, se devuelve un valor vacío. Para las tarjetas de interfaz de red (NIC) principales, se devuelve el número de colas predeterminado para las NIC principales del tipo de instancia.	8
PrivateIpSets	object
PrivateIpSet	array<object>	La colección de objetos PrivateIpSet.
	array<object>
PrivateIpAddress	string	La dirección IP privada de la instancia.	172.17..
Primary	boolean	Indica si la dirección IP es la dirección IP privada principal. Valores válidos: true: dirección IP privada principal. false: dirección IP privada secundaria.	true
AssociatedPublicIp	object	La dirección IP elástica (EIP) asociada con la tarjeta de interfaz de red (NIC).
PublicIpAddress	string	La dirección EIP.	116.62..
AllocationId	string	Nota Este parámetro se encuentra en vista previa por invitación y no está disponible públicamente.	null
PrivateDnsName	string	El nombre de dominio privado de la instancia. Nota Este valor se devuelve solo cuando el tipo de nombre de host `HostnameType` de la instancia se establece en formato `IP` o formato `InstanceId`.	DnsTestName
Ipv6Sets	object
Ipv6Set	array<object>	Las direcciones IPv6 asignadas a la tarjeta de interfaz de red (NIC).
	object
Ipv6Address	string	La dirección IPv6 asignada a la tarjeta de interfaz de red (NIC).	2408:4321:180:1701:94c7:bc38:3bfa:****
Primary	boolean
Ipv4PrefixSets	object
Ipv4PrefixSet	array<object>	Los prefijos IPv4 asignados a la tarjeta de interfaz de red (NIC).
	object
Ipv4Prefix	string	The IPv4 prefix allocated to the network interface controller (NIC).	192.168.**.0/28
Ipv6PrefixSets	object
Ipv6PrefixSet	array<object>	Los prefijos IPv6 asignados a la tarjeta de interfaz de red (NIC).
	object
Ipv6Prefix	string	The IPv6 prefix allocated to the network interface controller (NIC).	2001:db8:1234:1a00:****::/80
Tags	object
Tag	array<object>	Las etiquetas.
	object
TagValue	string	El valor de la etiqueta.	TestValue
TagKey	string	La clave de la etiqueta.	TestKey
SecurityGroupIds	object
SecurityGroupId	array	Los security groups a los que pertenece la ENI.
	string	El ID del security group.	sg-bp18kz60mefsicfg****
AssociatedPublicIp	object	La EIP asociada con la dirección IP privada secundaria de la tarjeta de interfaz de red (NIC).
PublicIpAddress	string	La dirección EIP.	116.62..
AllocationId	string	Nota Este parámetro se encuentra en vista previa por invitación y no está disponible públicamente.	null
Attachment	object	Nota Este parámetro se encuentra en vista previa por invitación y no está disponible públicamente.
DeviceIndex	integer	Nota Este parámetro se encuentra en vista previa por invitación y no está disponible públicamente.	0
InstanceId	string	Nota Este parámetro se encuentra en vista previa por invitación y no está disponible públicamente.	null
TrunkNetworkInterfaceId	string	Nota Este parámetro se encuentra en vista previa por invitación y no está disponible públicamente.	null
NetworkCardIndex	integer	El índice de la tarjeta de red a la que está conectada la ENI. Si la ENI está en estado Available o no se especificó el índice durante la conexión, este valor no se devuelve. Si la ENI está en estado InUse y se especificó el índice durante la conexión, este valor indica el índice de la tarjeta de red a la que está conectada la ENI.	0
DeleteOnRelease	boolean	Indica si la ENI se conserva cuando se libera la instancia asociada. Valores válidos: true: la ENI no se conserva. false: la ENI se conserva.	true
SourceDestCheck	boolean	Indica si la verificación de origen/destino está habilitada. Se recomienda habilitar esta función para mejorar la seguridad de la red. Valores válidos: true: habilitada. false: deshabilitada. Valor predeterminado: false. Nota Antes de utilizar este parámetro, lea Verificación de origen/destino.	false

Ejemplos

Respuesta exitosa

JSON Formato

{
  "NextToken": "AAAAAdDWBF2****",
  "PageSize": 1,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 2,
  "NetworkInterfaceSets": {
    "NetworkInterfaceSet": [
      {
        "CreationTime": "2019-12-25T12:31:31Z",
        "VpcId": "vpc-bp1j7w3gc1cexjqd****",
        "Type": "Secondary",
        "Status": "Available",
        "NetworkInterfaceTrafficMode": "Standard",
        "NetworkInterfaceName": "my-eni-name",
        "MacAddress": "00:16:3e:12:**:**",
        "QueuePairNumber": 0,
        "NetworkInterfaceId": "eni-bp125p95hhdhn3ot****",
        "ServiceID": 12345678910,
        "InstanceId": "i-bp1e2l6djkndyuli****",
        "OwnerId": "123456****",
        "ServiceManaged": true,
        "VSwitchId": "vsw-bp16usj2p27htro3****",
        "Description": "DescriptionTest",
        "ResourceGroupId": "rg-2ze88m67qx5z****",
        "ZoneId": "cn-hangzhou-e",
        "PrivateIpAddress": "172.17.**.**",
        "QueueNumber": 8,
        "PrivateIpSets": {
          "PrivateIpSet": [
            {
              "PrivateIpAddress": "172.17.**.**",
              "Primary": true,
              "AssociatedPublicIp": {
                "PublicIpAddress": "116.62.**.**",
                "AllocationId": "null"
              },
              "PrivateDnsName": "DnsTestName"
            }
          ]
        },
        "Ipv6Sets": {
          "Ipv6Set": [
            {
              "Ipv6Address": "2408:4321:180:1701:94c7:bc38:3bfa:****",
              "Primary": false
            }
          ]
        },
        "Ipv4PrefixSets": {
          "Ipv4PrefixSet": [
            {
              "Ipv4Prefix": "192.168.**.0/28"
            }
          ]
        },
        "Ipv6PrefixSets": {
          "Ipv6PrefixSet": [
            {
              "Ipv6Prefix": "2001:db8:1234:1a00:****::/80"
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "SecurityGroupIds": {
          "SecurityGroupId": [
            "sg-bp18kz60mefsicfg****"
          ]
        },
        "AssociatedPublicIp": {
          "PublicIpAddress": "116.62.**.**",
          "AllocationId": "null"
        },
        "Attachment": {
          "DeviceIndex": 0,
          "InstanceId": "null",
          "TrunkNetworkInterfaceId": "null",
          "NetworkCardIndex": 0
        },
        "DeleteOnRelease": true,
        "SourceDestCheck": false
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	MissingParameter	%s	A parameter is not specified.
400	UnsupportedParameter	%s	The parameter is not supported.
400	InvalidParameter	%s	The specified parameter is invalid.
400	InvalidInstanceID.Malformed	%s	The specified InstanceId parameter is invalid.
400	InvalidOperation.InvalidEcsState	%s	This operation is not allowed in the current cloud service status.
400	InvalidOperation.InvalidEniState	%s	The current state of the ENI does not allow this operation.
400	InvalidOperation.DetachPrimaryEniNotAllowed	%s	Detaching the primary ENI from an instance is not allowed.
400	Forbidden.RegionId	%s	The service is unavailable in the current region.
400	InvalidRegionId.MalFormed	The specified parameter RegionId is not valid.	The specified RegionId parameter is invalid.
403	InvalidUserType.NotSupported	%s	Your account does not support this operation.
403	Abs.InvalidAccount.NotFound	%s	Your Alibaba Cloud account does not exist or your AccessKey pair has expired.
403	Forbidden.NotSupportRAM	%s	RAM users are not authorized to perform this operation.
403	Forbidden.SubUser	%s	You are not authorized to manage this resource. Contact the owner of the Alibaba Cloud account for authorization.
403	InvalidParameter	%s
403	MaxEniCountExceeded	%s	The maximum number of ENIs that can be managed has been reached.
403	EniPerInstanceLimitExceeded	%s	The maximum number of ENIs that can be attached to the specified instance has been reached.
403	InvalidOperation.AvailabilityZoneMismatch	%s	The operation is invalid.
403	InvalidOperation.VpcMismatch	%s	The operation is invalid. Check whether the VPC in the operation corresponds to other parameters.
403	SecurityGroupInstanceLimitExceed	%s	The maximum number of instances in the security group has been reached.
403	InvalidSecurityGroupId.NotVpc	%s	The specified SecurityGroupId parameter is invalid and the network type of the security group is not VPC.
403	InvalidOperation.InvalidEniType	%s	This operation is not allowed for the current network interface type.
403	InvalidVpc.Empty	%s	No vSwitches exist in the specified VPC. For more information, see the return value of the %s placeholder in the error message.
403	Forbidden.RegionId	%s
403	InvalidOperation.InvalidEniPageNumber	%s
403	InvalidVpc.Indeterminacy	%s
404	InvalidEcsId.NotFound	%s	The specified instance ID does not exist.
404	InvalidEniId.NotFound	%s
404	InvalidVSwitchId.NotFound	%s	The specified vSwitch does not exist.
404	InvalidSecurityGroupId.NotFound	%s	The specified security group ID does not exist.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.