You need to enable JavaScript to run this app.
文档中心
私有网络

私有网络

复制全文
下载 pdf
网卡
DescribeNetworkInterfaceAttributes - 查询网卡详细信息
复制全文
下载 pdf
DescribeNetworkInterfaceAttributes - 查询网卡详细信息
调用 DescribeNetworkInterfaceAttributes 接口,查看指定网卡的详情。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值:DescribeNetworkInterfaceAttributes​
接口名称。当前 API 的名称为DescribeNetworkInterfaceAttributes。​
​
Version String 必选 示例值:2020-04-01​
接口版本。当前 API 的版本为 2020-04-01。​
​
NetworkInterfaceId String 必选 示例值:eni-bp1fgnh68xyz9****​
网卡的ID。​
您可以调用 DescribeNetworkInterfaces 接口,查询网卡的ID。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
RequestId String 示例值:2021062415303301022514515207C4****​
请求ID。​
​
AccountId String 示例值:2010****​
网卡所属账户的ID。​
​
NetworkInterfaceId String 示例值:eni-bpacfmxazb4p****​
网卡的ID。​
​
NetworkInterfaceName String 示例值:eniTestName​
网卡名称。​
​
Description String 示例值:TestDescription​
网卡描述信息。​
​
VpcId String 示例值:vpc-bpacfmxazb4p****​
网卡所属的VPC的ID。​
​
VpcName String 示例值:vpc-name​
网卡所属VPC的名称。​
​
ZoneId String 示例值:cn-****​
网卡所属可用区的ID。​
​
SubnetId String 示例值:subnet-128fhnvjjgg****​
网卡所属的子网。​
​
MacAddress String 示例值:XX.XX.XX.XX.XX.XX​
网卡的Mac地址。​
​
DeviceId String 示例值:i-hjkib****9​
网卡挂载的实例的ID。如果网卡未挂载或参数ServiceManaged的值为true,则DeviceId返回值均为空。​
​
Type String 示例值:secondary​
网卡的类型。​
  • primary:主网卡​
  • secondary:辅助网卡​
​
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:否。​
​
​
​
​
IPv6Sets String[] 示例值:2408::153:3921:XX:XX:7b12:1c5f​
网卡的私网IPv6地址。​
​
Status String 示例值:InUse​
网卡的绑定状态。​
  • Creating:创建中​
  • Available:未挂载​
  • Attaching:挂载中​
  • InUse:已挂载​
  • Detaching:卸载中​
  • Deleting:删除中​
​
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-3ztdcid****90cjtjb​
网卡关联的安全组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-09T10:20:41+08:00​
更新网卡的时间。​
​
TcpClosedAndTimeWaitTimeout Integer 示例值:2​
TCP连接关闭超时时间。即设置TCP连接四次挥手关闭过程的最大等待响应时长,超时未完成挥手则强制断开连接、释放会话资源。​
​
TcpEstablishedTimeout Integer 示例值:910​
TCP连接空闲超时时间。即设置TCP连接无数据传输的最大保留时长,超时自动断开连接并释放会话资源。​
​
UdpTimeout Integer 示例值:32​
UDP流超时时间。即设置双向UDP会话无往返流量的最大空闲保留时长,超时自动删除会话、释放资源。​
​
​
​
请求示例​
​
GET /?Action=DescribeNetworkInterfaceAttributes&Version=2020-04-01&NetworkInterfaceId=eni-bp1fgnh68xyz9**** HTTP/1.1​
Host: vpc.cn-beijing.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/vpc/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2021062415303301022514515207C4****",​
"Action": "DescribeNetworkInterfaceAttributes",​
"Version": "2020-04-01",​
"Service": "vpc",​
"Region": "cn-beijing"​
},​
"Result": {​
"RequestId": "2021062415303301022514515207C4****",​
"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": {​
"EipAddress": "101.XX.XX.199",​
"AllocationId": "eip-3tczde6w4449q06m****",​
"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"​
}​
}​
​
错误码​
​
状态码​
错误码​
错误信息​
说明​
400​
DryRunOperation​
Exception raised to indicate a successfully authorized action when the DryRun flag is set to true.​
该请求设置为DryRun操作,操作授权已获得许可,但未被实际执行。​
400​
Forbidden.TrafficMode​
You are not authorized to perform operations on the specified network interface.​
您无权在指定的网络接口上执行操作。​
403​
Forbidden​
You are not authorized to perform operations on the specified elastic network interface.​
无权限对指定的弹性网卡进行操作。​
404​
InvalidEniId.NotFound​
The specified elastic network interface does not exist.​
指定的弹性网卡不存在。​
429​
RateLimited​
Too many requests, please try again later.​
请求过多,请稍后重试。​
​
​
最近更新时间:2026.09.17 15:49:20
这个页面对您有帮助吗?
有用
有用
无用
无用