私有网络

私有网络

产品文档

私有网络

帮助中心 > OpenAPI & SDK > 私有网络 > describeNetworkInterfaces
搜本产品

describeNetworkInterfaces

描述

查询弹性网卡列表

请求方式

GET

请求地址

https://vpc.jdcloud-api.com/v1/regions/{regionId}/networkInterfaces/

名称 类型 是否必需 默认值 描述
regionId String True Region ID

请求参数

名称 类型 是否必需 默认值 描述
pageNumber Integer False 1 页码, 默认为1, 取值范围：[1,∞), 页码超过总页数时, 显示最后一页
pageSize Integer False 20 分页大小，默认为20，取值范围：[10,100]
filters Filter[ ] False networkInterfaceIds - 弹性网卡ID列表，支持多个
networkInterfaceNames - 弹性网卡名称列表，支持多个
vpcId - 弹性网卡所属vpc Id，支持单个
subnetId - 弹性网卡所属子网Id，支持单个
role - 网卡角色，取值范围：Primary（主网卡）、Secondary（辅助网卡）、Managed （受管网卡），支持单个

Filter

名称 类型 是否必需 默认值 描述
name String True 过滤条件的名称
operator String False 过滤条件的操作符，默认eq
values String[ ] True 过滤条件的值

返回参数

名称 类型 描述
result Result 返回结果
requestId String 请求ID

Result

名称 类型 描述
networkInterfaces NetworkInterface[ ] networkInterface资源信息列表
totalCount Number 总数量

NetworkInterface

名称 类型 描述
networkInterfaceName String 弹性网卡名称
networkInterfaceId String 弹性网卡ID
az String 可用区名称，该参数无效，不建议使用
role String 网卡角色，取值范围：Primary（主网卡）、Secondary（辅助网卡）
macAddress String 以太网地址
vpcId String 虚拟网络ID
subnetId String 子网ID
networkSecurityGroupIds String[ ] 安全组ID列表
sanityCheck Integer 源和目标IP地址校验，取值为0或者1
primaryIp NetworkInterfacePrivateIp 网卡主IP
secondaryIps NetworkInterfacePrivateIp[ ] 网卡附属IP列表
secondaryCidrs String[ ] 网卡附属IP网段
instanceType String 关联实例类型，取值范围：vm
instanceId String 关联实例ID
instanceOwnerId String 实例所属的账号
deviceIndex Integer 网卡在实例上的设备索引号，取值范围：[0,8]，0：辅助网卡未绑定设备，1：主网卡，2-8：辅助网卡已绑定设备
description String 网卡描述信息
attachmentStatus String 弹性网卡绑定实例状态，attached（已绑定）、detached（未绑定）
networkInterfaceStatus String 弹性网卡可用状态，enabled（启用）、disabled（停用）
createdTime String 弹性网卡创建时间

NetworkInterfacePrivateIp

名称 类型 描述
privateIpAddress String 私有IP的IPV4地址
elasticIpId String 弹性IP实例ID
elasticIpAddress String 弹性IP实例地址

返回码

返回码 描述
200 OK
400 invalid parameter
401 Authentication failed

请求示例

调用方法、签名算法及公共请求参数请参考京东云OpenAPI公共说明。

  • 请求示例: 查询vpc ID为vpc-c10xjyfiaf的弹性网卡列表

GET

  /v1/regions/cn-north-1/networkInterfaces?pageNumber=1&&pageSize=10&filters.1.name=vpcIds&filters.1.values.1=vpc-c10xjyfiaf

返回示例

{
    "requestId": "57edc810-ceaa-43a8-8e76-47d401387a6f", 
    "result": {
        "networkInterfaces": [
            {
                "attachmentStatus": "attached", 
                "az": "cn-south-1b", 
                "createdTime": "2021-07-30T13:43:51Z", 
                "description": "", 
                "deviceIndex": 1, 
                "instanceId": "i-1kch0awxq9", 
                "instanceOwnerId": "boss-01", 
                "instanceType": "compute", 
                "macAddress": "fa:16:3e:ab:be:10", 
                "networkInterfaceId": "port-zhi9fqz09q", 
                "networkInterfaceName": "", 
                "networkInterfaceStatus": "enabled", 
                "networkSecurityGroupIds": [
                    "sg-0yb6oqxxc0"
                ], 
                "primaryIp": {
                    "elasticIpAddress": "114.67.178.43", 
                    "elasticIpId": "fip-svj6u4mw6t", 
                    "privateIpAddress": "10.0.0.3"
                }, 
                "role": "Primary", 
                "sanityCheck": 0, 
                "secondaryCidrs": [ ], 
                "secondaryIps": [ ], 
                "subnetId": "subnet-wobzpv8cng", 
                "vpcId": "vpc-c10xjyfiaf"
            }, 
            {
                "attachmentStatus": "attached", 
                "az": "", 
                "createdTime": "2021-07-30T13:38:47Z", 
                "description": "", 
                "deviceIndex": 0, 
                "instanceId": "router-tgyzigc2o1", 
                "instanceOwnerId": "boss-01", 
                "instanceType": "N/A", 
                "macAddress": "fa:16:3e:9d:16:f4", 
                "networkInterfaceId": "port-3qgi2bz20m", 
                "networkInterfaceName": "", 
                "networkInterfaceStatus": "enabled", 
                "networkSecurityGroupIds": [ ], 
                "primaryIp": {
                    "elasticIpAddress": "", 
                    "elasticIpId": "", 
                    "privateIpAddress": "10.0.0.1"
                }, 
                "role": "", 
                "sanityCheck": 0, 
                "secondaryCidrs": [ ], 
                "secondaryIps": [ ], 
                "subnetId": "subnet-wobzpv8cng", 
                "vpcId": "vpc-c10xjyfiaf"
            }, 
            "..."
        ], 
        "totalCount": 11
    }
}
更新时间：2021-11-16 21:40:02
feedback