You need to enable JavaScript to run this app.
导航

DescribeNetworkInterfaces

最近更新时间2024.01.09 07:24:10

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

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

调用说明

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

调试

请求参数

参数名称
类型
是否必选
示例值
描述
ActionStringDescribeNetworkInterfaces要执行的操作。取值:DescribeNetworkInterfaces。
VersionString2020-04-01API版本信息,取值为:2020-04-01。
NetworkInterfaceNameStringeni-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地址之间用&分隔。
ZoneIdStringcn-beijing-a网卡所属可用区的ID。当前已支持的可用区可参见地域和可用区

SecurityGroupId

String

sg-123edfgt8hhvj***

网卡关联安全组的ID。
您可以调用 DescribeSecurityGroups 接口,查询安全组的ID。

Status

String

InUse

网卡状态。取值如下:

  • Creating:创建中。
  • Available:未挂载。
  • Attaching:挂载中。
  • InUse:已挂载。
  • Detaching:卸载中。
  • Deleting:删除中。
ProjectNameStringdefault网卡所属的项目。

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。

说明

本参数即将下线,建议您使用NextTokenMaxResults进行分页查询。

PageSize

Integer

20

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

说明

本参数即将下线,建议您使用NextTokenMaxResults进行分页查询。

NextToken

String

caeba0bbb2be03f84eb48b699f0a****

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

  • 不填则从头开始查询。
  • 传入之前调用本API返回的NextToken,则从该次API调用标记分页的位置往后开始查询。
MaxResultsInteger50查询的数量,默认为 10,最大为100。

返回数据

参数名称
类型
示例值
描述
RequestIdString2021062415303301022514515207C4****请求ID。

TotalCount

Integer

2

符合条件的网卡总数。

说明

本参数即将下线,使用NextTokenMaxResults分页查询时,此参数无意义。

PageNumber

Integer

1

当前页码。

说明

本参数即将下线,建议您使用NextTokenMaxResults进行分页查询。

PageSize

Integer

10

当前分页的行数。

说明

本参数即将下线,建议您使用NextTokenMaxResults进行分页查询。

NextToken

String

caeba0bbb2be03f84eb48b699f0a****

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

NetworkInterfaceSetsArray of Struct-网卡信息集合,具体请见“ NetworkInterfaceSets结构 ”。

NetworkInterfaceSets结构

参数名称
类型
示例值
描述
CreatedAtString2021-04-09T08:36:47+08:00创建网卡的时间。
UpdatedAtString2021-04-09T08:36:47+08:00更新网卡的时间。
AccountIdString200015网卡所有者ID。
DescriptionStringTestDescription网卡描述信息。
NetworkInterfaceIdStringeni-bpacfmxazb4p****网卡ID。
NetworkInterfaceNameStringeniTestName网卡名称。
VpcIdStringvpc-bpacfmxazb4p****网卡所属VPC的ID。
ZoneIdStringcn-beijing-a网卡所属可用区的ID。
VpcNameStringvpc-name网卡所属VPC的名称。
SubnetIdStringsubnet-128fhnvjjgg****网卡所属子网的ID。
MacAddressStringXX.XX.XX.XX.XX.XX网卡的Mac地址。
DeviceIdStringi-xfgf***x网卡绑定实例的ID。如果网卡未挂载或参数ServiceManagedtrue,则DeviceId返回值均为空。
TypeStringprimary网卡的类型。
PrimaryIpAddressString192.XX.XX.10网卡的主私网IPv4地址。
StatusStringInUse网卡的绑定状态。
SecurityGroupIdsArray["sg-9tczdi****mctjb","sg-3tznys4****mctjb"]网卡关联的安全组ID。

PortSecurityEnabled

Boolean

true

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

  • true:是。
  • false:否。
AssociatedElasticIpStruct-网卡主私网IPv4地址绑定的公网IP的信息。具体请见下方“ AssociatedElasticIp结构 ”表。

Attachment

Struct

-

是否随云服务器实例删除。具体请见下表“Attachment结构”。

说明

辅助网卡开启随云服务器实例删除的功能正在邀测中,如需使用,请提交工单或联系客户经理。

ServiceManaged

Boolean

false

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

  • true:是。
  • false:否。
PrivateIpSetsStruct-网卡辅助私网IPv4地址列表。具体请参见下方“PrivateIpSet结构”表。
Ipv6SetsArray["2408::153:3921:XX:XX:7b12:1c5f", "2408:4008:2cf:XX:XX:dd1e:2a22:5ddf"]网卡的IPv6地址列表。
ProjectNameStringdefault网卡所属项目的名称。
TagsArray of Struct-网卡的标签信息。具体请参见下表“Tag结构”。

PrivateIpSet结构

参数名称
类型
示例值
描述
PrivateIpAddressString192.168.XX.10网卡的辅助私网IPv4地址。
AssociatedElasticIpStruct-网卡辅助私网IPv4地址关联的公网IP。具体请见下表“AssociatedElasticIp结构”。

Primary

Boolean

false

是否为主私网IPv4地址。

  • true:主私网IPv4地址。
  • false:辅助私网IPv4地址。

AssociatedElasticIp结构

参数名称
类型
示例值
描述
AllocationIdStringeip-3tczd49q06mc****公网IP的ID。
EipAddressString101.XX.XX.199公网IP的地址。

Attachment结构

参数名称
类型
示例值
描述

DeleteOnTermination

Boolean

false

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

  • true:开启。
  • false:关闭。
InstanceIdStringi-wijfn35c****云服务器实例的ID。

Tag结构

参数名称
类型
示例值
描述
KeyStringk1网卡标签的标签键。
ValueStringv1网卡标签的标签值。

请求示例

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****",
        "TotalCount": 2,
        "PageNumber": 1,
        "PageSize": 20,
        "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
        "NetworkInterfaceSets": [
            {
                "CreatedAt": "2021-07-23T17:49:21+08:00",
                "UpdatedAt": "2021-07-23T17:49:24+08:00",
                "AccountId": "210000****",
                "Status": "InUse",
                "Description": "",
                "NetworkInterfaceId": "eni-2ff3dn0hbrfuo5oxruuqp****",
                "NetworkInterfaceName": "wsh-test-eni-1",
                "VpcId": "vpc-3tj9fo0uqy3vj0x2****",
                "VpcName": "test",
                "ZoneId": "cn-beijing-a",
                "SubnetId": "subnet-3tj9fva4dm3vj0x2****",
                "MacAddress": "00:16:3e:XX:XX:61",
                "DeviceId": "i-3tkkmwa1t63vj0x0****",
                "Type": "primary",
                "PrimaryIpAddress": "172.XX.XX.16",
                "PortSecurityEnabled": false,
                "ServiceManaged": false,
                "PrivateIpSets": [
                    {
                        "PrivateIpAddress": "10.XX.XX.245",
                        "AssociatedElasticIp": {
                                 "EipAddress": "101.XX.XX.199",
                                 "AllocationId": "eip-3tczde6w4449q06m****"
                             },
                         "Primary": true
                     }
                ],
                "SecurityGroupIds": [
                    "sg-3tj9fo0uqy3vj0x2****"
                ],
                "AssociatedElasticIp": {
                    "AllocationId": "eip-3tczde6w4449q06m****",
                    "EipAddress": "101.XX.XX.199"
                }, 
                "Ipv6Sets": [
                    "2408::153:3921:XX:XX:7b12:1c5f",
                    "2408:4008:2cf:XX:XX:dd1e:2a22:5ddf"
                ],
                "Attachment": {
                    "DeleteOnTermination": false,
                    "InstanceId": "i-wijfn35c****"
                },
                "ProjectName": "default", 
                "Tags": [ 
                    { 
                        "Key":"k1", 
                        "Value":"v1" 
                    }, 
                    { 
                        "Key":"k2", 
                        "Value":"" 
                    } 
                ]
            }
        ]
    }
}

错误码

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

HttpCode
错误码
错误信息
描述
400InvalidMaxResults.MalformedThe specified parameter MaxResults is malformed.查询数量不合法。
400InvalidNextToken.MalformedThe specified parameter NextToken is invalid.查询 NextToken 不合法。
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。
400InvalidTagFilter.DisorderThe specified index order of tag filter is malformed.指定标签过滤项的索引顺序参数格式不合法。
400InvalidTagFilterKey.MalformedThe specified parameter tag filter key is invalid.过滤标签键不合法。
400InvalidTagFilterValue.MalformedThe specified parameter tag filter value is invalid.过滤标签值不合法。
400LimitExceeded.IPv6AddressesYou've reached the limit on the number of IPv6 addresses that you can describe.已达到可查询的IPv6地址数量上限。
400LimitExceeded.NetworkInterfaceIDsYou've reached the limit on the number of eni IDs that you can describe.已达到可查询的弹性网卡ID数量上限。
400LimitExceeded.PrimaryIPAddressesYou've reached the limit on the number of primary IPs that you can describe.已达到可查询的主网卡IP数量上限。
400LimitExceeded.PrivateIPAddressesYou've reached the limit on the number of private IPs that you can describe.已达到可查询的私网IP数量上限。
400LimitExceeded.TagFilterKeyYou've reached the limit on the number of tag keys that you can filter.已达到单次可指定过滤标签键数量的上限。
400LimitExceeded.TagFilterValueYou've reached the limit on the number of tag values that you can filter.已达到单次可指定过滤标签值数量的上限。
404InvalidSubnet.NotFoundThe specified subnet does not exist.指定的子网不存在。
404InvalidVpc.NotFoundThe specified VPC does not exist.指定的VPC不存在。