Queries the details of an elastic network interface (ENI). When you call this operation, you can set the NetworkInterfaceId parameter to specify an ENI.
Operation description
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| 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 ENI. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| Tag | array<object> | No | Note
This parameter is unavailable.
| |
| object | No | Note
This parameter is unavailable.
| ||
| Key | string | No | Note
This parameter is unavailable.
| TestKey |
| Value | string | No | Note
This parameter is unavailable.
| TestValue |
| NetworkInterfaceId | string | Yes | The ID of the ENI. | eni-bp67acfmxazb4p**** |
| Attribute | string | No | The attribute of the ENI. Valid value: attachment: attachment information about the ENI Note
This parameter is in invitational preview and is not publicly available.
| attachment |
Response parameters
Examples
Sample success responses
JSONformat
{
"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::****"
}
]
},
"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
}
}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. |
| 404 | InvalidEniId.NotFound | %s | The specified ENI ID does not exist. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-09-14 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-07-03 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-05-17 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-05-07 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-02-01 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-10-09 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-01-04 | The Error code has changed. The response structure of the API has changed | View Change Details |