调用DescribeNetworkInterfaces接口，并可以指定ResourceGroupId、VSwitchId、InstanceId等参数，查询一个或多个弹性网卡（ENI）的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecs:DescribeNetworkInterfaces | get | *NetworkInterface acs:ecs:{#regionId}:{#accountId}:eni/{#eniId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 所在地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| Tag | array<object> | 否 | 标签列表 | |
| object | 否 | |||
| Key | string | 否 | 弹性网卡的标签键。N 的取值范围：1~20 | TestKey |
| Value | string | 否 | 弹性网卡的标签值。N 的取值范围：1~20 使用一个标签过滤资源，查询到该标签下的资源数量不能超过 1000 个；使用多个标签过滤资源，查询到同时绑定了多个标签的资源数量不能超过 1000 个。如果资源数量超过 1000 个，请使用 ListTagResources 接口进行查询。 | TestValue |
| ResourceGroupId | string | 否 | 资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。 说明
不支持默认资源组过滤。
| rg-bp67acfmxazb4p**** |
| VSwitchId | string | 否 | 弹性网卡所属的交换机 ID。 | vsw-bp16usj2p27htro3**** |
| VpcId | string | 否 | 弹性网卡所属的专有网络 VPC ID。 | vpc-bp1j7w3gc1cexjqd**** |
| PrimaryIpAddress | string | 否 | 弹性网卡主私网 IPv4 地址。 | 192.168.**.** |
| SecurityGroupId | string | 否 | 辅助网卡对应的安全组 ID。
| sg-bp144yr32sx6ndw**** |
| NetworkInterfaceName | string | 否 | 弹性网卡的名称。长度为 2~128 个字符，支持 Unicode 中 letter 分类下的字符（其中包括英文、中文和数字等）。可以包含半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。 | test-eni-name |
| Type | string | 否 | 弹性网卡类型。取值范围：
默认值：空，表示查询所有类型。 | Secondary |
| InstanceId | string | 否 | 弹性网卡当前附加的实例 ID。 | i-bp1e2l6djkndyuli**** |
| ServiceManaged | boolean | 否 | 该弹性网卡的使用者是否为云产品或虚商。 | true |
| Status | string | 否 | 弹性网卡的状态。取值范围：
默认值：空，表示查询所有状态。 | Available |
PageNumberdeprecated | integer | 否 | 说明
该参数已废弃，建议您通过指定 MaxResults 或 NextToken 参数时使用分页方式查询。
| 1 |
PageSizedeprecated | integer | 否 | 说明
该参数已废弃，建议您通过指定 MaxResults 或 NextToken 参数时使用分页方式查询。
| 100 |
| NextToken | string | 否 | 查询凭证（Token），取值为上一次 API 调用返回的 有关本接口查看返回数据的设置方式，请参见上文接口说明。 | AAAAAdDWBF2**** |
| MaxResults | integer | 否 | 分页查询时每页的最大条目数。取值范围：10~500。 默认值：
| 50 |
| PrivateIpAddress | array | 否 | 弹性网卡的辅助私网 IPv4 地址。N 的取值范围：1~100。 | |
| string | 否 | 弹性网卡的辅助私网 IPv4 地址。N 的取值范围：1~100。 | 192.168.**.** | |
| NetworkInterfaceId | array | 否 | 弹性网卡 ID。N 的取值范围：1~100。 | |
| string | 否 | 弹性网卡 ID。N 的取值范围：1~100。 | eni-bp125p95hhdhn3ot**** | |
| Ipv6Address | array | 否 | 弹性网卡的 IPv6 地址。N 表示可以设置多个 IPv6 地址，N 的取值范围：1~100。 | |
| string | 否 | 弹性网卡的 IPv6 地址。N 表示可以设置多个 IPv6 地址，N 的取值范围：1~100。 | 2408:4321:180:1701:94c7:bc38:3bfa:**** |
返回参数
示例
正常返回示例
JSON格式
{
"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:****"
}
]
},
"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
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | MissingParameter | %s | 缺失参数，请检查参数是否完整。 |
| 400 | UnsupportedParameter | %s | 不支持参数。 |
| 400 | InvalidParameter | %s | 无效的参数。 |
| 400 | InvalidInstanceID.Malformed | %s | 参数 InstanceId 格式错误。 |
| 400 | InvalidOperation.InvalidEcsState | %s | 实例当前的状态不支持此操作。 |
| 400 | InvalidOperation.InvalidEniState | %s | 弹性网卡当前的状态不支持此操作。 |
| 400 | InvalidOperation.DetachPrimaryEniNotAllowed | %s | 不允许分离实例的主网卡。 |
| 400 | Forbidden.RegionId | %s | 当前地域暂时没有提供该服务。 |
| 400 | InvalidRegionId.MalFormed | The specified parameter RegionId is not valid. | 指定的 RegionId 不合法。 |
| 403 | InvalidUserType.NotSupported | %s | 您当前的账号不支持此操作。 |
| 403 | Abs.InvalidAccount.NotFound | %s | 您的阿里云账号不存在，或者您的 AccessKey 已经过期。 |
| 403 | Forbidden.NotSupportRAM | %s | 暂不支持RAM用户执行该操作。 |
| 403 | Forbidden.SubUser | %s | 您的账号没有操作此资源的权限，请向主账号申请相关的权限。 |
| 403 | MaxEniCountExceeded | %s | 已超过可以操作的最大弹性网卡数。 |
| 403 | EniPerInstanceLimitExceeded | %s | 实例附加的弹性网卡数量已经达到了最大限度，不能再为实例附加弹性网卡。 |
| 403 | InvalidOperation.AvailabilityZoneMismatch | %s | 该操作无效。 |
| 403 | InvalidOperation.VpcMismatch | %s | 您的操作无效，请确认该操作中的 VPC 与其它参数是否匹配。 |
| 403 | SecurityGroupInstanceLimitExceed | %s | 该安全组内已有的实例数量已达到最大限制。 |
| 403 | InvalidSecurityGroupId.NotVpc | %s | 参数 SecurityGroupId 无效，该安全组的网络类型不是专有网络。 |
| 403 | InvalidOperation.InvalidEniType | %s | 当前弹性网卡的类型不支持此操作。 |
| 403 | InvalidVpc.Empty | %s | 指定的VPC下没有创建交换机，具体信息请参见错误信息%s占位符的实际返回结果。 |
| 403 | InvalidOperation.InvalidEniPageNumber | %s | - |
| 403 | InvalidVpc.Indeterminacy | %s | - |
| 404 | InvalidEcsId.NotFound | %s | 指定的实例 ID 不存在。 |
| 404 | InvalidEniId.NotFound | %s | 指定的弹性网卡 ID 不存在。 |
| 404 | InvalidVSwitchId.NotFound | %s | 指定的交换机不存在。 |
| 404 | InvalidSecurityGroupId.NotFound | %s | 指定的安全组 ID 不存在。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-09-14 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-08-08 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-10-09 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-01-04 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2021-05-20 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |