You need to enable JavaScript to run this app.
导航
私有网络
  • 文档首页
    • /私有网络/API参考/网卡/DescribeNetworkInterfaceAttributes
DescribeNetworkInterfaceAttributes
最近更新时间：2024.07.17 10:35:15首次发布时间：2021.07.29 14:11:54
我的收藏

调用 DescribeNetworkInterfaceAttributes 接口，查看指定网卡的详情。

调试

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

请求参数

参数名称
类型
是否必选
示例值
描述
ActionString是DescribeNetworkInterfaceAttributes要执行的操作。取值：DescribeNetworkInterfaceAttributes。
VersionString是2020-04-01API版本信息，取值为：2020-04-01。

NetworkInterfaceId

String

是

eni-bp1fgnh68xyz9****

网卡的ID。
您可以调用 DescribeNetworkInterfaces 接口，查询网卡的ID。

返回数据

参数名称
类型
示例值
描述
RequestIdString2021062415303301022514515207C4****请求ID。
AccountIdString2010****网卡所属账户的ID。
NetworkInterfaceIdStringeni-bpacfmxazb4p****网卡的ID。
NetworkInterfaceNameStringeniTestName网卡名称。
DescriptionStringTestDescription网卡描述信息。
VpcIdStringvpc-bpacfmxazb4p****网卡所属的VPC的ID。
VpcNameStringvpc-name网卡所属VPC的名称。
ZoneIdStringcn-****网卡所属可用区的ID。
SubnetIdStringsubnet-128fhnvjjgg****网卡所属的子网。
MacAddressStringXX.XX.XX.XX.XX.XX网卡的Mac地址。
DeviceIdStringi-hjkib****9网卡挂载的实例的ID。如果网卡未挂载或参数ServiceManaged的值为true，则DeviceId返回值均为空。
TypeStringsecondary网卡的类型。
  • primary：主网卡
  • secondary：辅助网卡
    • PrimaryIpAddressString192.XX.XX.10网卡的主私网IPv4地址。
    AssociatedElasticIpStruct-网卡主私网IPv4关联的公网IP的信息，具体请见下表“ AssociatedElasticIp结构 ”。
    PrivateIpSetsStruct-网卡的私网IPv4地址列表。具体请参见下表“PrivateIpSet结构”。
    IPv6SetsArray["2408::153:3921:XX:XX:7b12:1c5f", "2408:4008:2cf:XX:XX:dd1e:2a22:5ddf"]网卡的私网IPv6地址。
    StatusStringInUse网卡的绑定状态。
  • Creating：创建中
  • Available：未挂载
  • Attaching：挂载中
  • InUse：已挂载
  • Detaching：卸载中
  • Deleting：删除中

    • PortSecurityEnabled

    Boolean

    true

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

    • true：是。
    • false：否。
    AttachmentStruct-是否随云服务器实例删除。具体请见下表“Attachment结构”。

    ServiceManaged

    Boolean

    false

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

    • true：是。
    • false：否。
    SecurityGroupIdsArray["sg-3ztdcid****90cjtjb","sg-3tc0zdiz****qctbdej"]网卡关联的安全组ID。
    ProjectNameStringdefault网卡所属项目的名称。
    TagsArray of Struct-网卡的标签信息。具体请参见下表“Tag结构”。
    CreatedAtString2021-04-09T08:36:47+08:00创建网卡的时间。
    UpdatedAtString2021-04-09T10:20:41+08:00更新网卡的时间。

    PrivateIpSet结构

    参数名称
    类型
    示例值
    描述
    PrivateIpAddressString192.XX.XX.10网卡的私网IP地址。

    Primary

    Boolean

    true

    是否为主私网IPv4地址。

    • true：主私网IPv4地址
    • false：辅助私网IPv4地址
    AssociatedElasticIpStruct-网卡私网IPv4地址关联的公网IP。具体请见下表“AssociatedElasticIp结构”。

    AssociatedElasticIp结构

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

    ReleaseWithInstance

    Boolean

    true

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

    • true：是。
    • false：否。

    Attachment结构

    参数名称
    类型
    示例值
    描述

    DeleteOnTermination

    Boolean

    false

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

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

    Tag结构

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

    请求示例

    GET /?Action=DescribeNetworkInterfaceAttributes&Version=2020-04-01&NetworkInterfaceId=eni-bp1fgnh68xyz9**** HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

    返回示例

    {
    "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"
    }
}

    错误码

    当前API无错误码，更多错误码请参见公共错误码。