DescribeNetworkInterfaces

GET /?Action=DescribeNetworkInterfaces
Description

Describes one or more Flexible Network Interface (FNI).
An FNI is a virtual network interface that you can attach to an instance in a Virtual Private Cloud (VPC).
You can use the Filter.N parameter to filter FNIs on the following properties:

  • addresses.private-ip-address: The private IP addresses associated with the FNI.

  • addresses.primary: Whether the private IP address is the primary IP address associated with the FNI.

  • addresses.association.public-ip: The association ID returned when the FNI was associated with an External IP address (EIP).

  • addresses.association.owner-id: The account ID of the owner of the IP addresses associated with the FNI.

  • association.association-id: The association ID returned when the FNI was associated with an EIP.

  • association.allocation-id: The allocation ID returned when you allocated the EIP to your account.

  • association.ip-owner-id: The account ID of the owner of the EIP associated with the FNI.

  • association.public-ip: The EIP associated with the FNI.

  • association.public-dns-name: The public DNS name associated with the EIP.

  • attachment.attachment-id: The attachment ID of the FNI.

  • attachment.instance-id: The ID of the instance the FNI is attached to.

  • attachment.instance-owner-id: The account ID of the owner of the instance the FNI is attached to.

  • attachment.device-index: The device index used for the FNI.

  • attachment.status: The state of the attachment.

  • attachment.attach.time: The time at which the FNI was attached to an instance.

  • attachment.delete-on-termination: Whether the FNI is deleted when the instance it is attached to is terminated.

  • availability-zone: The Availability Zone (AZ) where the FNI is located.

  • description: The description of the FNI.

  • group-id: The ID of a security group associated with the FNI.

  • group-name: The name of a security group associated with the FNI.

  • mac-address: The Media Access Control (MAC) address of the FNI.

  • network-interface-id: The ID of the FNI.

  • owner-id: The account ID of the FNI owner.

  • private-ip-address: The primary private IP address of the FNI.

  • private-dns-name: The private DNS name associated with the primary private IP address.

  • source-dest-check: Whether the source/destination checking is enabled (true) or disabled (false).

  • status: The state of the FNI.

  • subnet-id: The ID of the subnet in where the FNI is located.

  • vpc-id: The ID of the VPC in where the FNI is located.

Note

If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.
Body parameter

Required: false
Name: DescribeNetworkInterfacesRequest

Name Description Required Schema Default Example

Filter.N

One or more filters. Example:
osc-cli fcu DescribeNetworkInterfaces \
  --Filter.1.Name "network-interface-id" \
  --Filter.1.Value.1 "eni-12345678"

false

Filter

NetworkInterfaceId.N

One or more FNI IDs.

false

string
Responses
HTTP Code 200
HTTP Code Description Schema

200

DescribeNetworkInterfacesResult

Response 200

Response 200

Name Description Required Schema Default Example

networkInterfaceSet.N

Information about the FNIs.

false

NetworkInterface

requestId

The ID of the request.

false

string