文档中心

DescribeNetworkInterfaces

最近更新时间：2024.05.09 10:18:47

首次发布时间：2021.07.29 14:11:54

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

调用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的网卡，若没有符合条件的网卡，则返回空值。
若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有网卡。
使用标签过滤资源时，最多可查询指定标签关联的1000个资源。如果指定标签关联的资源超过1000个，则只返回前1000个。此时请使用ListTagsForResources接口查询。

调试

API Explorer

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

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeNetworkInterfaces	要执行的操作。取值：DescribeNetworkInterfaces。
Version	String	是	2020-04-01	API版本信息，取值为：2020-04-01。
NetworkInterfaceName	String	否	eni-1	网卡的名称。
NetworkInterfaceIds.N	String	否	NetworkInterfaceIds.1=eni-bp1fg6nh**&NetworkInterfaceIds.2=eni-5nh68xyz9**	网卡的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	否	PrimaryIpAddresses.1=192.XX.XX.10&PrimaryIpAddresses.2=10.XX.XX.16	网卡的主私网IPv4地址。参数 - N：表示网卡主私网IPv4地址的序号，单次调用数量上限为100个。多张网卡的主私网IPv4地址之间用&分隔。
PrivateIpAddresses.N	String	否	PrivateIpAddresses.1=192.168.XX.10&PrivateIpAddresses.2=192.168.XX.12	网卡的辅助私网IPv4地址。参数 - N：表示辅助私网IPv4的序号，单次调用数量上限为100个。多个私网IPv4地址之间用&分隔。说明传入此参数需同时传入`VpcId`。
Ipv6Addresses.N	String	否	Ipv6Addresses.1=2408::153:3921:XX:XX:7b12:1c5f&Ipv6Addresses.2=2408:4008:2cf:XX:XX:dd1e:2a22:5ddf	网卡的私网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	否	TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3	标签的标签键。参数 - N：表示标签键的序号，取值范围：1～10。多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的网卡。不允许重复。
TagFilters.N.Values.N	String	否	TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=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	Array of Struct	-	网卡信息集合，具体请见“ NetworkInterfaceSets结构 ”。

NetworkInterfaceSets结构

参数名称	类型	示例值	描述
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	Struct	-	网卡主私网IPv4地址绑定的公网IP的信息。具体请见下方“ AssociatedElasticIp结构 ”表。
PrivateIpSets	Struct	-	网卡私网IPv4地址列表。具体请参见下方“PrivateIpSet结构”表。
Ipv6Sets	Array	["2408::153:3921:XX:XX:7b12:1c5f", "2408:4008:2cf:XX:XX:dd1e:2a22:5ddf"]	网卡的IPv6地址列表。
Status	String	InUse	网卡的绑定状态。
PortSecurityEnabled	Boolean	true	是否为网卡开启源/目的地址检查。开启后，系统会自动阻止源地址或目的地址不是当前网卡的流量。 true：是。 false：否。
Attachment	Struct	-	是否随云服务器实例删除。具体请见下表“Attachment结构”。说明辅助网卡开启随云服务器实例删除的功能正在邀测中，如需试用，请联系客户经理。
ServiceManaged	Boolean	false	是否为火山引擎官方服务网卡。即创建中转路由器、私网连接、NAT网关、VPN连接、负载均衡等服务时，系统自动创建的一张网卡，为相应的后台服务提供私有网络。 true：是。 false：否。
SecurityGroupIds	Array	["sg-9tczdi**mctjb","sg-3tznys4**mctjb"]	网卡关联的安全组ID。
ProjectName	String	default	网卡所属项目的名称。
Tags	Array of Struct	-	网卡的标签信息。具体请参见下表“Tag结构”。
CreatedAt	String	2021-04-09T08:36:47+08:00	创建网卡的时间。
UpdatedAt	String	2021-04-09T08:36:47+08:00	更新网卡的时间。

PrivateIpSet结构

参数名称	类型	示例值	描述
PrivateIpAddress	String	192.168.XX.10	网卡的私网IPv4地址。
Primary	Boolean	false	是否为主私网IPv4地址。 true：主私网IPv4地址。 false：辅助私网IPv4地址。
AssociatedElasticIp	Struct	-	网卡辅助私网IPv4地址关联的公网IP。具体请见下表“AssociatedElasticIp结构”。

参数名称

类型

示例值

描述

PrivateIpAddress

String

192.168.XX.10

网卡的私网IPv4地址。

Primary

Boolean

false

是否为主私网IPv4地址。

true：主私网IPv4地址。
false：辅助私网IPv4地址。

AssociatedElasticIp

Struct

网卡辅助私网IPv4地址关联的公网IP。具体请见下表“AssociatedElasticIp结构”。

AssociatedElasticIp结构

参数名称	类型	示例值	描述
AllocationId	String	eip-3tczd49q06mc****	公网IP的ID。
EipAddress	String	101.XX.XX.199	公网IP的地址。
ReleaseWithInstance	Boolean	true	公网IP是否随云服务器实例删除。仅主网卡的主私网IP绑定按量计费公网IP有效。开启后，当云服务器实例被系统自动回收（退订24小时后、到期回收、欠费回收）或被调用DeleteInstances接口时，公网IP随其一同释放。 true：是。 false：否。

参数名称

类型

示例值

描述

AllocationId

String

eip-3tczd49q06mc****

公网IP的ID。

EipAddress

String

101.XX.XX.199

公网IP的地址。

ReleaseWithInstance

Boolean

true

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

true：是。
false：否。

Attachment结构

参数名称	类型	示例值	描述
InstanceId	String	i-wijfn35c****	云服务器实例的ID。
DeleteOnTermination	Boolean	false	是否开启随云服务器实例删除。 true：开启。 false：关闭。

参数名称

类型

示例值

描述

InstanceId

String

i-wijfn35c****

云服务器实例的ID。

DeleteOnTermination

Boolean

false

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

true：开启。
false：关闭。

Tag结构

参数名称	类型	示例值	描述
Key	String	k1	网卡标签的标签键。
Value	String	v1	网卡标签的标签值。

请求示例

GET /?Action=DescribeNetworkInterfaces&Version=2020-04-01&VpcId=vpc-bp15zckdt37pq72zv****&PageNumber=1&PageSize=100 HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribeNetworkInterfaces",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021062415303301022514515207C4****",
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
        "NetworkInterfaceSets": [
            {
                "AccountId": "210000****",            
                "NetworkInterfaceId": "eni-2ff3dn0hbrfuo5oxruuqp****",            
                "NetworkInterfaceName": "test-eni-1",            
                "Description": "",
                "VpcId": "vpc-3tj9fo0uqy3vj0x2****",
                "VpcName": "test",               
                "ZoneId": "cn-****",
                "SubnetId": "subnet-3tj9fva4dm3vj0x2****",
                "MacAddress": "XX:XX:XX:XX:XX:XX",                
                "DeviceId": "i-3tkkmwa1t63vj0x0****",
                "Type": "primary",                
                "PrimaryIpAddress": "172.XX.XX.16",
                "AssociatedElasticIp": {
                    "AllocationId": "eip-3tczde6w4449q06m****",
                    "EipAddress": "101.XX.XX.199",
                    "ReleaseWithInstance": true
                },
                "PrivateIpSets": {
                    "PrivateIpSet": [
                        {
                            "PrivateIpAddress": "10.XX.XX.245",
                            "Primary": true,
                            "AssociatedElasticIp": {
                                     "AllocationId": "eip-3tczde6w4449q06m****",  
                                     "EipAddress": "101.XX.XX.199",
                                     "ReleaseWithInstance": true
                                 }
                         }
                    ]
                }                
                "IPv6Sets": [
                    "2408::153:3921:XX:XX:7b12:1c5f",
                    "2408:4008:2cf:XX:XX:dd1e:2a22:5ddf"
                ],
                "Status": "InUse",              
                "PortSecurityEnabled": false,
                "Attachment": {
                    "DeleteOnTermination": false,
                    "InstanceId": "i-wijfn35c****"
                },
                "ServiceManaged": false,               
                "SecurityGroupIds": [
                    "sg-3tj9fo0uqy3vj0x2****"
                ],
                "ProjectName": "default",
                "Tags": [
                    {
                        "Key":"k1",
                        "Value":"v1"
                    },
                    {
                        "Key":"k2",
                        "Value":""
                    }
                ],                                                  
                "CreatedAt": "2021-07-23T17:49:21+08:00",
                "UpdatedAt": "2021-07-23T17:49:24+08:00"
            }
        ]
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
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	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不存在。

调用说明

调试

请求参数

返回数据

请求示例

返回示例

错误码

私有网络

DescribeNetworkInterfaces

调用说明

调试

请求参数

返回数据

请求示例

返回示例

错误码