Query elastic network interface attributes using DescribeNetworkInterfaceAttribute - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries the details of an Elastic Network Interface (ENI) by specifying the ENI ID.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeNetworkInterfaceAttribute

get

*NetworkInterface

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the network interface controller (NIC). You can invoke DescribeRegions to query the most recent region list.	cn-hangzhou
Tag	array<object>	No	Note This parameter is not available for use.
	object	No	Note This parameter is not available for use.
Key	string	No	Note This parameter is not available for use.	TestKey
Value	string	No	Note This parameter is not available for use.	TestValue
NetworkInterfaceId	string	Yes	The ID of the network interface controller (NIC).	eni-bp67acfmxazb4p****
Attribute	string	No	The property of the Elastic Network Interface (ENI). Valid values: attachment: queries the attachment information of member network interface controllers (NICs) for a trunk network interface controller (NIC). This parameter is in invitational preview and is not available for use. connectionTrackingConfiguration: queries the network connectivity tracking configuration. Default value:	attachment

Response elements

Element	Type	Description	Example
	object	The collection of ENI information.
CreationTime	string	The time when the network interface controller (NIC) was created.	2019-12-25T12:31:31Z
VpcId	string	The ID of the VPC to which the network interface controller (NIC) belongs.	vpc-bp67acfmxazb4p****
Type	string	The type of the Elastic Network Interface (ENI). Valid values: Primary: primary network interface controller (NIC). Secondary: secondary Elastic Network Interface (ENI).	Secondary
Status	string	The status of the network interface controller (NIC). Valid values: Available: active. Attaching: being attached. InUse: in use. Detaching: being detached. Deleting: being deleted. Default value: empty, which indicates that network interface controllers (NICs) in all statuses are queried.	Available
NetworkInterfaceTrafficMode	string	The communication pattern of the network interface controller (NIC). Valid values: Standard: uses the TCP communication pattern. HighPerformance: enables the Elastic RDMA Interface (ERI) and uses the RDMA communication pattern. Note The HighPerformance parameter value is supported only by the c7re RDMA enhanced instance family.	Standard
NetworkInterfaceName	string	The name of the network interface controller (NIC).	my-eni-name
MacAddress	string	The MAC address of the network interface controller (NIC).	00:16:3e:12::
QueuePairNumber	integer	Note This parameter is in invitational preview and is not publicly available.	22
NetworkInterfaceId	string	The ID of the network interface controller (NIC).	eni-bp125p95hhdhn3ot****
ServiceID	integer	The Virtual Network Operator (VNO) ID associated with the network interface controller (NIC).	12345678910
InstanceId	string	The ID of the instance to which the network interface controller (NIC) is attached. Note Network interface controllers (NICs) that are managed and controlled by other Alibaba Cloud services do not return an instance ID.	i-bp1e2l6djkndyuli****
OwnerId	string	The ID of the account that owns the network interface controller (NIC).	123456****
ServiceManaged	boolean	Indicates whether the user of the network interface controller (NIC) is an Alibaba Cloud service or a VNO.	true
VSwitchId	string	The ID of the vSwitch to which the network interface controller (NIC) belongs.	vsw-bp1s5fnvk4gn2tws0****
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
Description	string	The description of the network interface controller (NIC).	testDescription
ResourceGroupId	string	The ID of the resource group to which the instance belongs. When you use this parameter to filter resources, the resource count cannot exceed 1000. Note Filtering by the default resource group is not supported.	rg-bp67acfmxazb4p****
ZoneId	string	The zone ID.	cn-hangzhou-g
PrivateIpAddress	string	The private IP address of the network interface controller (NIC).	10.1..
QueueNumber	integer	The number of queues for the Elastic Network Interface (ENI). If the Elastic Network Interface (ENI) is a primary network interface controller (NIC): the default number of queues for the primary network interface controller (NIC) based on the instance type is returned. If the Elastic Network Interface (ENI) is a secondary ENI: If the secondary ENI is in the InUse state: If the number of queues has not been modified, the default number of queues for the secondary ENI based on the instance type is returned. If the number of queues has been modified, the modified number of queues is returned. If the secondary ENI is in the active (Available) state: If the number of queues has not been modified, an empty value is returned. If the number of queues has been modified, the modified number of queues is returned.	8
SecurityGroupIds	object
SecurityGroupId	array	The collection of security groups to which the network interface controller (NIC) belongs.
	string	The security group to which the network interface controller (NIC) belongs.	sg-bp18kz60mefsicfg****
AssociatedPublicIp	object	The Elastic IP Address (EIP) associated with the secondary private IP address of the network interface controller (NIC).
PublicIpAddress	string	The EIP address.	116.62..
AllocationId	string	The ID of the EIP.	null
Attachment	object	Note This parameter is in invitational preview and is not publicly available.
DeviceIndex	integer	Note This parameter is in invitational preview and is not publicly available.	hide
InstanceId	string	Note This parameter is in invitational preview and is not publicly available.	hide
TrunkNetworkInterfaceId	string	Note This parameter is in invitational preview and is not publicly available.	hide
MemberNetworkInterfaceIds	object
MemberNetworkInterfaceId	array	Note This parameter is in invitational preview and is not publicly available.
	string	Note This parameter is in invitational preview and is not publicly available.	hide
NetworkCardIndex	integer	The index of the network card to which the ENI is attached. If the ENI is in the Available state or the index was not specified during attachment, this value is not returned. If the ENI is in the InUse state and the index was specified during attachment, this value indicates the index of the network card to which the ENI is attached.	0
PrivateIpSets	object
PrivateIpSet	array<object>	The collection of private IP address information for the network interface controller (NIC).
	array<object>	The private IP address information of the network interface controller (NIC).
PrivateIpAddress	string	The private IP address of the network interface controller (NIC).	172.17..
Primary	boolean	Indicates whether the IP address is the primary private IP address. Valid values: true: primary private IP address. false: secondary private IP address.	true
AssociatedPublicIp	object	The Elastic IP Address (EIP) associated with the secondary private IP address of the network interface controller (NIC).
PublicIpAddress	string	The EIP address.	116.62..
AllocationId	string	Note This parameter is in invitational preview and is not publicly available.	null
Ipv6Sets	object
Ipv6Set	array<object>	The list of IPv6 addresses allocated to the network interface controller (NIC).
	object	The IPv6 address allocated to the network interface controller (NIC).
Ipv6Address	string	The IPv6 address assigned to the network interface controller (NIC).	2001:db8:1234:1a00::****
Primary	boolean
Ipv4PrefixSets	object
Ipv4PrefixSet	array<object>	The collection of IPv4 prefixes allocated to the network interface controller (NIC).
	object	The IPv4 prefix assigned.
Ipv4Prefix	string	The IPv4 prefix allocated to the network interface controller (NIC).	192.168.**.0/28
Ipv6PrefixSets	object
Ipv6PrefixSet	array<object>	The collection of IPv6 prefixes allocated to the network interface controller (NIC).
	object
Ipv6Prefix	string	The IPv6 prefix allocated to the network interface controller (NIC).	2001:db8:1234:1a00:****::/80
Tags	object
Tag	array<object>	The collection of tags for the network interface controller (NIC).
	object	The tag information of the network interface controller (NIC).
TagValue	string	The tag value.	TestValue
TagKey	string	The tag key.	TestKey
BondInterfaceSpecification	object	Note This parameter is in invitational preview and is not publicly available.
BondMode	string	Note This parameter is in invitational preview and is not publicly available.	null
SlaveInterfaceSpecification	object
SlaveInterfaceSpecificationSet	array<object>	Note This parameter is in invitational preview and is not publicly available.
	object	Note This parameter is in invitational preview and is not publicly available.
SlaveNetworkInterfaceId	string	Note This parameter is in invitational preview and is not publicly available.	null
WorkState	string	Note This parameter is in invitational preview and is not publicly available.	null
BondNetworkInterfaceId	string	Note This parameter is in invitational preview and is not publicly available.	null
SlaveInterfaceSpecification	object	Note This parameter is in invitational preview and is not publicly available.
SlaveNetworkInterfaceId	string	Note This parameter is in invitational preview and is not publicly available.	null
WorkState	string	Note This parameter is in invitational preview and is not publicly available.	null
BondNetworkInterfaceId	string	Note This parameter is in invitational preview and is not publicly available.	null
DeleteOnRelease	boolean	Indicates whether the ENI is retained when the associated instance is released. Valid values: true: The ENI is not retained. false: The ENI is retained.	true
TcpOptionAddressEnabled	string	Note This parameter is in invitational preview and is not publicly available.	null
NetworkInterfaceTrafficConfig	object	The traffic parameters of the network interface controller (NIC).
NetworkInterfaceTrafficMode	string	The communication pattern of the network interface controller (NIC).	HighPerformance
QueueNumber	integer	The number of queues for the network interface controller (NIC).	8
QueuePairNumber	integer	The number of RDMA queue pairs.	8
ConnectionTrackingConfiguration	object	The collection of network connectivity tracking configuration information. Before you use this parameter, read Connection timeout management. Note This parameter is returned only when the `Attribute` input parameter is set to `connectionTrackingConfiguration`.
TcpEstablishedTimeout	integer	The timeout period for TCP connections in the established state. Unit: seconds. Valid values: [30, 60, 80, 100, 200, 300, 500, 700, 910].	910
TcpClosedAndTimeWaitTimeout	integer	The timeout period for TCP connections in the TIME_WAIT and CLOSED states. Unit: seconds. Valid values: an integer from 3 to 15. Note If your ECS instance is used with NLB or CLB, the default timeout period for connections in the `TIME_WAIT` state is 15 seconds.	3
UdpTimeout	integer	The timeout period for UDP flows. Unit: seconds. Valid values: [10, 20, 30, 60, 80, 100]. Note If your ECS instance is used with NLB or CLB, the default value is 100 seconds.	30
SourceDestCheck	boolean	This parameter is not publicly available.	false
EnhancedNetwork	object	This parameter is not publicly available.
EnableSriov	boolean	This parameter is not publicly available.	false
EnableRss	boolean	Note This parameter is not available for use.	true
VirtualFunctionTotalQueueNumber	integer
VirtualFunctionQuantity	integer
EnableExpress	boolean
QoSConfig	object	The QoS rate limit settings.
EnableQoS	boolean	Indicates whether QoS rate limiting is enabled.
QoS	object	The QoS rate limit settings.
BandwidthTx	integer	The maximum outbound internal bandwidth limit.	50000
BandwidthRx	integer	The maximum inbound internal bandwidth limit.	50000
PpsTx	integer	The outbound internal network packet forwarding rate.	50000
PpsRx	integer	The inbound internal network packet forwarding rate.	50000
ConcurrentConnections	integer	The maximum number of sessions.	50000

Examples

Success response

JSON format

{
  "CreationTime": "2019-12-25T12:31:31Z",
  "VpcId": "vpc-bp67acfmxazb4p****",
  "Type": "Secondary",
  "Status": "Available",
  "NetworkInterfaceTrafficMode": "Standard",
  "NetworkInterfaceName": "my-eni-name",
  "MacAddress": "00:16:3e:12:**:**",
  "QueuePairNumber": 22,
  "NetworkInterfaceId": "eni-bp125p95hhdhn3ot****",
  "ServiceID": 12345678910,
  "InstanceId": "i-bp1e2l6djkndyuli****",
  "OwnerId": "123456****",
  "ServiceManaged": true,
  "VSwitchId": "vsw-bp1s5fnvk4gn2tws0****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "Description": "testDescription",
  "ResourceGroupId": "rg-bp67acfmxazb4p****",
  "ZoneId": "cn-hangzhou-g",
  "PrivateIpAddress": "10.1.**.**",
  "QueueNumber": 8,
  "SecurityGroupIds": {
    "SecurityGroupId": [
      "sg-bp18kz60mefsicfg****"
    ]
  },
  "AssociatedPublicIp": {
    "PublicIpAddress": "116.62.**.**",
    "AllocationId": "null"
  },
  "Attachment": {
    "DeviceIndex": 0,
    "InstanceId": "hide",
    "TrunkNetworkInterfaceId": "hide",
    "MemberNetworkInterfaceIds": {
      "MemberNetworkInterfaceId": [
        "hide"
      ]
    },
    "NetworkCardIndex": 0
  },
  "PrivateIpSets": {
    "PrivateIpSet": [
      {
        "PrivateIpAddress": "172.17.**.**",
        "Primary": true,
        "AssociatedPublicIp": {
          "PublicIpAddress": "116.62.**.**",
          "AllocationId": "null"
        }
      }
    ]
  },
  "Ipv6Sets": {
    "Ipv6Set": [
      {
        "Ipv6Address": "2001:db8:1234:1a00::****",
        "Primary": false
      }
    ]
  },
  "Ipv4PrefixSets": {
    "Ipv4PrefixSet": [
      {
        "Ipv4Prefix": "192.168.**.0/28"
      }
    ]
  },
  "Ipv6PrefixSets": {
    "Ipv6PrefixSet": [
      {
        "Ipv6Prefix": "2001:db8:1234:1a00:****::/80"
      }
    ]
  },
  "Tags": {
    "Tag": [
      {
        "TagValue": "TestValue",
        "TagKey": "TestKey"
      }
    ]
  },
  "BondInterfaceSpecification": {
    "BondMode": "null",
    "SlaveInterfaceSpecification": {
      "SlaveInterfaceSpecificationSet": [
        {
          "SlaveNetworkInterfaceId": "null",
          "WorkState": "null",
          "BondNetworkInterfaceId": "null"
        }
      ]
    }
  },
  "SlaveInterfaceSpecification": {
    "SlaveNetworkInterfaceId": "null",
    "WorkState": "null",
    "BondNetworkInterfaceId": "null"
  },
  "DeleteOnRelease": true,
  "TcpOptionAddressEnabled": "null",
  "NetworkInterfaceTrafficConfig": {
    "NetworkInterfaceTrafficMode": "HighPerformance",
    "QueueNumber": 8,
    "QueuePairNumber": 8
  },
  "ConnectionTrackingConfiguration": {
    "TcpEstablishedTimeout": 910,
    "TcpClosedAndTimeWaitTimeout": 3,
    "UdpTimeout": 30
  },
  "SourceDestCheck": false,
  "EnhancedNetwork": {
    "EnableSriov": false,
    "EnableRss": true,
    "VirtualFunctionTotalQueueNumber": 0,
    "VirtualFunctionQuantity": 0,
    "EnableExpress": false
  },
  "QoSConfig": {
    "EnableQoS": false,
    "QoS": {
      "BandwidthTx": 50000,
      "BandwidthRx": 50000,
      "PpsTx": 50000,
      "PpsRx": 50000,
      "ConcurrentConnections": 50000
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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	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
404	InvalidEniId.NotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.