DescribeNetworkInterfaces - - Centro de documentación de Alibaba Cloud

Consulta los detalles de las interfaces de red elásticas (ENI).

Notas de uso

Puede llamar a la operación DescribeNetworkInterfaces para realizar una consulta paginada si especifica el parámetro MaxResults o NextToken. Durante una consulta paginada, al llamar a la operación DescribeNetworkInterfaces para obtener la primera página de resultados, establezca MaxResults para indicar el número máximo de entradas que se devolverán en la llamada. El valor devuelto de NextToken es un token de paginación que puede usarse en la siguiente llamada para recuperar una nueva página de resultados. Cuando llame a la operación DescribeNetworkInterfaces para obtener una nueva página de resultados, establezca NextToken con el valor de NextToken devuelto en la llamada anterior y configure MaxResults para especificar el número máximo de entradas que se devolverán en esta llamada.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que llame a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DescribeNetworkInterfaces	La operación que desea ejecutar. Establezca el valor en DescribeNetworkInterfaces.
RegionId	String	Sí	cn-hangzhou	El ID de región de la ENI. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.
Tag.N.Key	String	No	TestKey	La clave de la etiqueta N de la ENI. Valores válidos de N: 1 a 20.
Tag.N.Value	String	No	TestValue	El valor de la etiqueta N de la ENI. Valores válidos de N: 1 a 20. Si se especifica una sola etiqueta para consultar recursos, la respuesta puede mostrar hasta 1,000 recursos que tengan dicha etiqueta. Si se especifican varias etiquetas para consultar recursos, la respuesta puede mostrar hasta 1,000 recursos que contengan todas esas etiquetas. Para consultar más de 1,000 ENI con etiquetas específicas, llame a la operación ListTagResources.
ResourceGroupId	String	No	rg-bp67acfmxazb4p****	El ID del resource group. Si se especifica este parámetro para consultar recursos, se devuelven hasta 1,000 recursos pertenecientes al resource group indicado. Nota Las ENI del resource group predeterminado se muestran en la respuesta sin importar cómo se configure este parámetro.
VSwitchId	String	No	vsw-bp16usj2p27htro3****	El ID del vSwitch al que está conectada la ENI.
VpcId	String	No	vpc-bp1j7w3gc1cexjqd****	El ID de la virtual private cloud (VPC) a la que pertenece la ENI.
PrimaryIpAddress	String	No	192.168..	La dirección IPv4 privada principal de la ENI.
SecurityGroupId	String	No	sg-bp144yr32sx6ndw****	El ID del security group al que pertenece la ENI secundaria. Para consultar los detalles de las ENI secundarias según el ID de un security group, especifique este parámetro. Para consultar los detalles de las ENI principales según el ID de un security group, llame a la operación DescribeInstances con el parámetro `SecurityGroupId` especificado.
NetworkInterfaceName	String	No	test-eni-name	El nombre de la ENI.
Type	String	No	Secondary	El tipo de la ENI. Valores válidos: Primary Secondary Este parámetro está vacío de forma predeterminada, lo que indica que se consultan tanto las ENI principales como las secundarias.
InstanceId	String	No	i-bp1e2l6djkndyuli****	El ID de la instancia a la que está vinculada la ENI.
ServiceManaged	Boolean	No	true	Especifica si el usuario de la ENI es un servicio de Alibaba Cloud o un distribuidor.
Status	String	No	Available	El estado de la ENI. Valores válidos: Available: La ENI está disponible. Attaching: La ENI se está vinculando a una instancia. InUse: La ENI está vinculada a una instancia. Detaching: La ENI se está desvinculando de una instancia. Deleting: La ENI se está eliminando. Este parámetro está vacío de forma predeterminada, lo que indica que se consultan las ENI en todos los estados.
PageNumber	Integer	No	1	Nota Este parámetro ya no se utiliza. Le recomendamos que especifique el parámetro MaxResults o NextToken para realizar una consulta paginada.
PageSize	Integer	No	100	Nota Este parámetro ya no se utiliza. Le recomendamos que especifique el parámetro MaxResults o NextToken para realizar una consulta paginada.
NextToken	String	No	AAAAAdDWBF2****	El token de paginación que se usa en la siguiente solicitud para recuperar una nueva página de resultados. No necesita especificar este parámetro en la primera solicitud. Debe especificar el token obtenido de la consulta anterior como valor de `NextToken`. Para obtener información sobre cómo revisar las respuestas devueltas por esta operación, consulte la sección "Notas de uso" en este tema.
MaxResults	Integer	No	50	El número máximo de entradas por página. Valores válidos: 10 a 500. Valor predeterminado: Si no se especifica este parámetro o si se establece en un valor menor a 10, el valor predeterminado es 10. Si se establece este parámetro en un valor mayor a 500, se utiliza el valor predeterminado de 500.
PrivateIpAddress.N	String	No	192.168..	La dirección IPv4 privada secundaria N de la ENI. Valores válidos de N: 1 a 100.
NetworkInterfaceId.N	String	No	eni-bp125p95hhdhn3ot****	El ID de la ENI N. Valores válidos de N: 1 a 100.
Ipv6Address.N	String	No	2408:4321:180:1701:94c7:bc38:3bfa:****	La dirección IPv6 N de la ENI. Valores válidos de N: 1 a 100.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
NextToken	String	AAAAAdDWBF2****	Un token de paginación. Puede usarse en la siguiente solicitud para recuperar una nueva página de resultados.
PageSize	Integer	1	El número de entradas por página. Nota Este parámetro se eliminará en el futuro. Le recomendamos usar los parámetros NextToken y MaxResults para realizar una consulta paginada.
PageNumber	Integer	1	El número de página. Nota Este parámetro se eliminará en el futuro. Le recomendamos usar los parámetros NextToken y MaxResults para realizar una consulta paginada.
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	El ID de la solicitud.
TotalCount	Integer	2	El número total de ENI devueltas. Nota Si especifica los parámetros `MaxResults` y `NextToken` para realizar una consulta paginada, el valor del parámetro de respuesta `TotalCount` no es válido.
NetworkInterfaceSets	Array of NetworkInterfaceSet		Los detalles de las ENI.
NetworkInterfaceSet
CreationTime	String	2019-12-25T12:31:31Z	La hora en que se creó la ENI.
VpcId	String	vpc-bp1j7w3gc1cexjqd****	El ID de la VPC a la que pertenece la ENI.
Type	String	Secondary	El tipo de la ENI.
Status	String	Available	El estado de la ENI.
NetworkInterfaceTrafficMode	String	Standard	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 directo a memoria remota (RDMA) con Elastic RDMA Interface (ERI) habilitado. Nota El parámetro solo puede tener el valor HighPerformance cuando la ENI está vinculada a una instancia c7re mejorada para RDMA ubicada en Beijing Zone K.
NetworkInterfaceName	String	my-eni-name	El nombre de la ENI.
MacAddress	String	00:16:3e:12::	La dirección de control de acceso a medios (MAC) de la ENI.
QueuePairNumber	Integer	0	Nota Este parámetro se encuentra en vista previa por invitación y no está disponible públicamente.
NetworkInterfaceId	String	eni-bp125p95hhdhn3ot****	El ID de la ENI.
ServiceID	Long	12345678910	El ID del distribuidor al que pertenece la ENI.
InstanceId	String	i-bp1e2l6djkndyuli****	El ID de la instancia a la que está vinculada la ENI. Nota Si otros servicios de Alibaba Cloud gestionan y controlan la ENI, no se devuelve ningún ID de instancia.
OwnerId	String	123456****	El ID de la cuenta a la que pertenece la ENI.
ServiceManaged	Boolean	true	Indica si el usuario de la ENI es un servicio de Alibaba Cloud o un distribuidor.
VSwitchId	String	vsw-bp16usj2p27htro3****	El ID del vSwitch asociado a la ENI.
Description	String	DescriptionTest	La descripción de la ENI.
ResourceGroupId	String	rg-2ze88m67qx5z****	El ID del resource group al que pertenece la ENI.
ZoneId	String	cn-hangzhou-e	El ID de zona de la ENI.
PrivateIpAddress	String	172.17..	La dirección IP privada de la ENI.
QueueNumber	Integer	8	El número de colas compatibles con la ENI. Si la ENI es una ENI secundaria en estado InUse (InUse) y nunca se ha modificado el número de colas admitidas, se devuelve el número predeterminado de colas por ENI secundaria que admite el tipo de instancia. Si se modificó el número de colas admitidas por la ENI secundaria, se devuelve el nuevo número de colas. Si la ENI es una ENI secundaria en estado Available (Available) y nunca se ha modificado el número de colas admitidas, se devuelve un valor vacío. Si la ENI es una ENI principal, se devuelve el número predeterminado de colas por ENI principal que admite el tipo de instancia.
PrivateIpSets	Array of PrivateIpSet		Las direcciones IP privadas de la ENI.
PrivateIpSet
PrivateIpAddress	String	172.17..	La dirección IP privada de la ENI.
Primary	Boolean	true	Indica si la dirección IP es la dirección IP privada principal. Valores válidos: true: La dirección IP es la dirección IP privada principal. false: La dirección IP es una dirección IP privada secundaria.
AssociatedPublicIp	Object		Detalles sobre la elastic IP address (EIP) asociada a la ENI.
PublicIpAddress	String	116.62..	La EIP de la ENI.
AllocationId	String	null	Nota Este parámetro se encuentra en vista previa por invitación y no está disponible públicamente.
Ipv6Sets	Array of Ipv6Set		Las direcciones IPv6 asignadas a la ENI.
Ipv6Set
Ipv6Address	String	2408:4321:180:1701:94c7:bc38:3bfa:****	La dirección IPv6 asignada a la ENI.
Ipv4PrefixSets	Array of Ipv4PrefixSet		Los prefijos IPv4 asignados a la ENI.
Ipv4PrefixSet
Ipv4Prefix	String	192.168.**.0/28	El prefijo IPv4 asignado a la ENI.
Ipv6PrefixSets	Array of Ipv6PrefixSet		Los prefijos IPv6 asignados a la ENI.
Ipv6PrefixSet
Ipv6Prefix	String	2001:db8:1234:1a00:****::/80	Los prefijos IPv6 asignados a la ENI.
Tags	Array of Tag		Las etiquetas de la ENI.
Tag
TagValue	String	TestValue	El valor de la etiqueta de la ENI.
TagKey	String	TestKey	La clave de la etiqueta de la ENI.
SecurityGroupIds	Array of String	sg-bp18kz60mefsicfg****	Los ID de los security groups a los que pertenece la ENI.
AssociatedPublicIp	Object		La EIP asociada a la dirección IP privada secundaria de la ENI.
PublicIpAddress	String	116.62..	La EIP de la ENI.
AllocationId	String	null	Nota Este parámetro se encuentra en vista previa por invitación y no está disponible públicamente.
Attachment	Object		Nota Este parámetro se encuentra en vista previa por invitación y no está disponible públicamente.
DeviceIndex	Integer	0	Nota Este parámetro se encuentra en vista previa por invitación y no está disponible públicamente.
InstanceId	String	null	Nota Este parámetro se encuentra en vista previa por invitación y no está disponible públicamente.
TrunkNetworkInterfaceId	String	null	Nota Este parámetro se encuentra en vista previa por invitación y no está disponible públicamente.
NetworkCardIndex	Integer	0	El índice de la tarjeta de red. Si la ENI está en estado Available (Available) o si no se especificó un índice de tarjeta de red al vincular la ENI, este parámetro no tiene valor. Si la ENI está en estado InUse (InUse) y se especificó un índice de tarjeta de red al vincular la ENI, se devuelve el índice especificado como valor de este parámetro.
DeleteOnRelease	Boolean	true	Indica si se debe liberar la ENI cuando se libera la instancia asociada. Valores válidos: true false

Ejemplos

Solicitudes de ejemplo

https://ecs.aliyuncs.com/?Action=DescribeNetworkInterfaces
&RegionId=cn-hangzhou
&PrivateIpAddress.1=192.168.**.**
&PrivateIpAddress.2=192.168.**.**
&NextToken=AAAAAdDWBF2****
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

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

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "AAAAAdDWBF2****",
  "PageSize" : 1,
  "PageNumber" : 1,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount" : 2,
  "NetworkInterfaceSets" : [ {
    "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" : [ {
      "PrivateIpAddress" : "172.17.**.**",
      "Primary" : true,
      "AssociatedPublicIp" : {
        "PublicIpAddress" : "116.62.**.**",
        "AllocationId" : "null"
      }
    } ],
    "Ipv6Sets" : [ {
      "Ipv6Address" : "2408:4321:180:1701:94c7:bc38:3bfa:****"
    } ],
    "Ipv4PrefixSets" : [ {
      "Ipv4Prefix" : "192.168.**.0/28"
    } ],
    "Ipv6PrefixSets" : [ {
      "Ipv6Prefix" : "2001:db8:1234:1a00:****::/80"
    } ],
    "Tags" : [ {
      "TagValue" : "TestValue",
      "TagKey" : "TestKey"
    } ],
    "SecurityGroupIds" : [ "sg-bp18kz60mefsicfg****" ],
    "AssociatedPublicIp" : {
      "PublicIpAddress" : "116.62.**.**",
      "AllocationId" : "null"
    },
    "Attachment" : {
      "DeviceIndex" : 0,
      "InstanceId" : "null",
      "TrunkNetworkInterfaceId" : "null",
      "NetworkCardIndex" : 0,
      "DeleteOnRelease" : "true"
    }
  } ]
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	MissingParameter	%s	No se especificó un parámetro obligatorio.
400	UnsupportedParameter	%s	Un parámetro especificado no es compatible.
400	InvalidParameter	%s	Valor de parámetro no válido.
400	InvalidInstanceID.Malformed	%s	Formato de InstanceId no válido.
400	InvalidOperation.InvalidEcsState	%s	Esta operación no se puede realizar en la instancia en su estado actual.
400	InvalidOperation.InvalidEniState	%s	Esta operación no se puede realizar en la ENI en su estado actual.
400	InvalidOperation.DetachPrimaryEniNotAllowed	%s	La ENI principal no se puede desvincular de la instancia.
400	Forbidden.RegionId	%s	El servicio no está disponible en la región por el momento.
400	InvalidRegionId.MalFormed	The specified parameter RegionId is not valid.	Valor de RegionId no válido.
403	InvalidUserType.NotSupported	%s	Su cuenta no admite esta operación.
403	Abs.InvalidAccount.NotFound	%s	No se encontró su cuenta de Alibaba Cloud o su par de AccessKey ha caducado.
403	Forbidden.NotSupportRAM	%s	Los usuarios de Resource Access Management (RAM) no tienen permisos para realizar esta operación.
403	Forbidden.SubUser	%s	No tiene acceso al recurso. Póngase en contacto con el propietario de la cuenta de Alibaba Cloud.
403	MaxEniCountExceeded	%s	Se superó el número máximo de ENI que se pueden gestionar.
403	EniPerInstanceLimitExceeded	%s	Se superó el número máximo de ENI que se pueden vincular a la instancia.
403	InvalidOperation.AvailabilityZoneMismatch	%s	La operación no es válida.
403	InvalidOperation.VpcMismatch	%s	La operación no es válida. Compruebe si la VPC de la operación corresponde a los demás parámetros.
403	SecurityGroupInstanceLimitExceed	%s	Se superó el número máximo de instancias en el security group.
403	InvalidSecurityGroupId.NotVpc	%s	ID de security group no válido. El tipo de red del security group especificado no es VPC.
403	InvalidOperation.InvalidEniType	%s	Esta operación no se puede realizar en este tipo de ENI.
403	InvalidVpc.Empty	%s	No existen vSwitches en la VPC especificada. Para obtener más información, consulte el valor devuelto del marcador de posición %s en el mensaje de error.
404	InvalidEcsId.NotFound	%s	No se encontró el ID de la instancia.
404	InvalidEniId.NotFound	%s	No se encontró el ID de la ENI.
404	InvalidVSwitchId.NotFound	%s	No se encontró el ID de vSwitch especificado.
404	InvalidSecurityGroupId.NotFound	%s	No se encontró el ID de security group especificado.

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.