调用 DescribeNetworkInterfaces 接口，查询满足指定条件的网卡。

使用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的网卡，若没有符合条件的网卡，则返回空值。

若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有网卡。

使用标签过滤资源时，最多可查询指定标签关联的1000个资源。如果指定标签关联的资源超过1000个，则只返回前1000个。此时请使用ListTagsForResources接口查询。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action String 必选示例值：DescribeNetworkInterfaces

接口名称。当前 API 的名称为DescribeNetworkInterfaces。

Version String 必选示例值：2020-04-01

接口版本。当前 API 的版本为 2020-04-01。

NetworkInterfaceName String 可选示例值：eni-1

网卡的名称。

NetworkInterfaceIds.N String 可选示例值：eni-bp1fg6nh****

网卡的ID。

参数 - N：表示网卡ID的序号，单次调用数量上限为100个。

多张网卡的ID之间用&分隔。

Type String 可选示例值：secondary

网卡类型。取值如下：

primary：主网卡。

secondary：辅助网卡。

InstanceId String 可选示例值：i-qodj57nvnc****

网卡挂载的云服务器ID。

您可以调用 DescribeInstances 接口，查询云服务器实例的ID。

VpcId String 可选示例值：vpc-bp15zckdt37pq72zv****

网卡所属VPC的ID。

您可以调用 DescribeVpcs 接口，查询VPC的ID。

SubnetId String 可选示例值：subnet-bp15zckdt37pq72zv****

网卡所属子网的ID。

您可以调用 DescribeSubnets 接口，查询子网的ID。

PrimaryIpAddresses.N String 可选示例值：192.XX.XX.10

网卡的主私网IPv4地址。

参数 - N：表示网卡主私网IPv4地址的序号，单次调用数量上限为100个。

多张网卡的主私网IPv4地址之间用&分隔。

PrivateIpAddresses.N String 可选示例值：192.168.XX.10

网卡的辅助私网IPv4地址。

参数 - N：表示辅助私网IPv4的序号，单次调用数量上限为100个。

多个私网IPv4地址之间用&分隔。

说明

传入此参数需同时传入VpcId。

Ipv6Addresses.N String 可选示例值：2408::153:3921:XX:XX:7b12:1c5f

网卡的私网IPv6地址。

参数 - N：表示网卡的私网IPv6地址的序号，单次调用数量上限为100个。

多个私网IPv6地址之间用&分隔。

说明

为网卡分配IPv6地址的功能正在邀测中，暂仅支持完成企业认证的账号申请试用，如需试用，请联系客户经理。

ZoneId String 可选示例值：cn-beijing-a

网卡所属可用区的ID。当前已支持的可用区可参见地域和可用区。

SecurityGroupId String 可选示例值：sg-123edfgt8hhvj***

网卡关联安全组的ID。

您可以调用 DescribeSecurityGroups 接口，查询安全组的ID。

Status String 可选示例值：InUse

网卡状态。取值如下：

Creating：创建中。

Available：未挂载。

Attaching：挂载中。

InUse：已挂载。

Detaching：卸载中。

Deleting：删除中。

ProjectName String 可选示例值：default

网卡所属的项目。

TagFilters.N.Key String 可选示例值：k1

标签的标签键。

参数 - N：表示标签键的序号，取值范围：1～10。

多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的网卡。

不允许重复。

TagFilters.N.Values.N String 可选示例值：v1

标签的标签值。

第一个N：表示标签键的序号，取值范围：1～10。

第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的网卡。

多个标签值之间用&分隔。

说明

若传入该参数，则必须先传入TagFilters.N.Key。

传入空字符串时，表示查询标签值为空的网卡。

PageNumber Integer 可选示例值：1

列表的页码。默认值为1。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

PageSize Integer 可选示例值：20

分页查询时每页的行数。最大值为100，默认值为20。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

NextToken String 可选示例值：caeba0bbb2be03f84eb48b699f0a****

分页查询凭证，用于标记分页的位置。

不填则从头开始查询。

传入之前调用本API返回的NextToken，则从该次API调用标记分页的位置往后开始查询。

MaxResults Integer 可选示例值：50

查询的数量，默认为 10，最大为100。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

RequestId String 示例值：2021062415303301022514515207C4****

请求ID。

TotalCount Integer 示例值：2

符合条件的网卡总数。

说明

本参数即将下线，使用NextToken和MaxResults分页查询时，此参数无意义。

PageNumber Integer 示例值：1

当前页码。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

PageSize Integer 示例值：10

当前分页的行数。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

NextToken String 示例值：caeba0bbb2be03f84eb48b699f0a****

本次API调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。

NetworkInterfaceSets Object[] 示例值：-

网卡信息集合。

AccountId String 示例值：200015

网卡所有者ID。

NetworkInterfaceId String 示例值：eni-bpacfmxazb4p****

网卡ID。

NetworkInterfaceName String 示例值：eniTestName

网卡名称。

Description String 示例值：TestDescription

网卡描述信息。

VpcId String 示例值：vpc-bpacfmxazb4p****

网卡所属VPC的ID。

ZoneId String 示例值：cn-beijing-a

网卡所属可用区的ID。

VpcName String 示例值：vpc-name

网卡所属VPC的名称。

SubnetId String 示例值：subnet-128fhnvjjgg****

网卡所属子网的ID。

MacAddress String 示例值：XX.XX.XX.XX.XX.XX

网卡的Mac地址。

DeviceId String 示例值：i-xfgf***x

网卡绑定实例的ID。如果网卡未挂载或参数ServiceManaged为true，则DeviceId返回值均为空。

Type String 示例值：primary

网卡的类型。

PrimaryIpAddress String 示例值：192.XX.XX.10

网卡的主私网IPv4地址。

AssociatedElasticIp Object 示例值：-

网卡主私网IPv4地址绑定的公网IP的信息。

AllocationId String 示例值：eip-3tc6w4446mctiq****

公网IP的ID。

EipAddress String 示例值：101.XX.XX.199

公网IP的IP地址。

ReleaseWithInstance Boolean 示例值：true

公网IP是否随云服务器实例删除。仅主网卡的主私网IP绑定按量计费公网IP有效。开启后，当云服务器实例被系统自动回收（退订24小时后、到期回收、欠费回收）或被调用DeleteInstances接口时，公网IP随其一同释放。

true：是。

false：否。

PrivateIpSets Object 示例值：-

网卡私网IPv4地址列表。

PrivateIpSet Object[] 示例值：-

网卡私网IPv4地址列表。

PrivateIpAddress String 示例值：192.XX.XX.10

网卡的私网IP地址。

Primary Boolean 示例值：true

是否为主私网IPv4地址。

true：主私网IPv4地址

false：辅助私网IPv4地址

AssociatedElasticIp Object 示例值：-

网卡私网IPv4地址关联的公网IP。

AllocationId String 示例值：eip-3tc6w4446mctiq****

公网IP的ID。

EipAddress String 示例值：101.XX.XX.199

公网IP的IP地址。

ReleaseWithInstance Boolean 示例值：true

公网IP是否随云服务器实例删除。仅主网卡的主私网IP绑定按量计费公网IP有效。开启后，当云服务器实例被系统自动回收（退订24小时后、到期回收、欠费回收）或被调用DeleteInstances接口时，公网IP随其一同释放。

true：是。

false：否。

Status String 示例值：InUse

网卡的绑定状态。

PortSecurityEnabled Boolean 示例值：true

是否为网卡开启源/目的地址检查。开启后，系统会自动阻止源地址或目的地址不是当前网卡的流量。

true：是。

false：否。

Attachment Object 示例值：-

是否随云服务器实例删除。

DeleteOnTermination Boolean 示例值：false

是否开启随云服务器实例删除。

true：开启。

false：关闭。

InstanceId String 示例值：i-wijfn35c****

云服务器实例的ID。

ServiceManaged Boolean 示例值：false

是否为火山引擎官方服务网卡。即创建中转路由器、私网连接、VPN连接等服务时，系统自动创建的一张网卡，为相应的后台服务提供私有网络。

true：是。

false：否。

SecurityGroupIds String[] 示例值：sg-9tczdi****mctjb

网卡关联的安全组ID。

ProjectName String 示例值：default

网卡所属项目的名称。

Tags Object[] 示例值：-

网卡的标签信息。

Key String 示例值：k1

标签的标签键。

Value String 示例值：v1

标签的标签值。

CreatedAt String 示例值：2021-04-09T08:36:47+08:00

创建网卡的时间。

UpdatedAt String 示例值：2021-04-09T08:36:47+08:00

更新网卡的时间。

UdpTimeout Integer 示例值：32

UDP流超时时间。即设置双向UDP会话无往返流量的最大空闲保留时长，超时自动删除会话、释放资源。

Ipv4PrefixSets String[] 示例值：["192.168.1.32/28"]

网卡添加的IPv4前缀委托。

说明

本参数正在邀测中，如需试用，请联系客户经理。

Ipv6PrefixSets String[] 示例值：["2001:db8:1234:XX::/80"]

网卡添加的IPv6前缀委托。

说明

本参数正在邀测中，如需试用，请联系客户经理。

TcpEstablishedTimeout Integer 示例值：910

TCP连接空闲超时时间。即设置TCP连接无数据传输的最大保留时长，超时自动断开连接并释放会话资源。

TcpClosedAndTimeWaitTimeout Integer 示例值：2

TCP连接关闭超时时间。即设置TCP连接四次挥手关闭过程的最大等待响应时长，超时未完成挥手则强制断开连接、释放会话资源。

请求示例

返回示例

错误码

状态码	错误码	错误信息	说明
400	Forbidden.TrafficMode	You are not authorized to perform operations on the specified network interface.	您无权在指定的网络接口上执行操作。
400	InvalidMaxResults.Malformed	The specified parameter MaxResults is malformed.	查询数量不合法。
400	InvalidNextToken.Malformed	The specified parameter NextToken is invalid.	查询 NextToken 不合法。
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	InvalidSecurityGroup.NotAuthorized	You are not authorized to operate invisible security group.	无权限操作隐藏安全组。
400	InvalidTagFilter.Disorder	The specified index order of tag filter is malformed.	指定标签过滤项的索引顺序参数格式不合法。
400	InvalidTagFilterKey.Malformed	The specified parameter tag filter key is invalid.	过滤标签键不合法。
400	InvalidTagFilterValue.Malformed	The specified parameter tag filter value is invalid.	过滤标签值不合法。
400	LimitExceeded.IPv6Addresses	You've reached the limit on the number of IPv6 addresses that you can describe.	已达到可查询的IPv6地址数量上限。
400	LimitExceeded.NetworkInterfaceIDs	You've reached the limit on the number of eni IDs that you can describe.	已达到可查询的弹性网卡ID数量上限。
400	LimitExceeded.PrimaryIPAddresses	You've reached the limit on the number of primary IPs that you can describe.	已达到可查询的主网卡IP数量上限。
400	LimitExceeded.PrivateIPAddresses	You've reached the limit on the number of private IPs that you can describe.	已达到可查询的私网IP数量上限。
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	已达到单次可指定过滤标签键数量的上限。
400	LimitExceeded.TagFilterValue	You've reached the limit on the number of tag values that you can filter.	已达到单次可指定过滤标签值数量的上限。
404	InvalidSubnet.NotFound	The specified subnet does not exist.	指定的子网不存在。
404	InvalidVpc.NotFound	The specified VPC does not exist.	指定的VPC不存在。