查询弹性网卡列表

最近更新时间:2018-10-26 15:01:38

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(DescribeNetworkInterfaces)用于查询弹性网卡列表。

默认接口请求频率限制:100次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeNetworkInterfaces
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
NetworkInterfaceIds.N Array of String 弹性网卡实例ID查询。形如:eni-pxir56ns。每次请求的实例的上限为100。参数不支持同时指定NetworkInterfaceIds和Filters。
Filters.N Array of Filter 过滤条件,参数不支持同时指定NetworkInterfaceIds和Filters。
  • vpc-id - String - (过滤条件)VPC实例ID,形如:vpc-f49l6u0z。
  • subnet-id - String - (过滤条件)所属子网实例ID,形如:subnet-f49l6u0z。
  • network-interface-id - String - (过滤条件)弹性网卡实例ID,形如:eni-5k56k7k7。
  • attachment.instance-id - String - (过滤条件)绑定的云服务器实例ID,形如:ins-3nqpdn3i。
  • groups.security-group-id - String - (过滤条件)绑定的安全组实例ID,例如:sg-f9ekbxeq。
  • network-interface-name - String - (过滤条件)网卡实例名称。
  • network-interface-description - String - (过滤条件)网卡实例描述。
  • Offset Integer 偏移量,默认为0。
    Limit Integer 返回数量,默认为20,最大值为100。

    3. 输出参数

    参数名称 类型 描述
    NetworkInterfaceSet Array of NetworkInterface 实例详细信息列表。
    TotalCount Integer 符合条件的实例数量。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询弹性网卡列表

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeNetworkInterfaces
    &Version=2017-03-12
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "NetworkInterfaceSet": [
          {
            "Attachment": {},
            "CreatedTime": "2017-11-16 19:56:00",
            "GroupSet": [
              "sg-c2r7lnxh",
              "sg-f9ekbxeq"
            ],
            "MacAddress": "20: 90: 6F: F3: 3D: BD",
            "NetworkInterfaceDescription": "",
            "NetworkInterfaceId": "eni-f1xjkw1b",
            "NetworkInterfaceName": "royhyangtest-main",
            "Primary": false,
            "PrivateIpAddressSet": [
              {
                "Description": "",
                "IsWanIpBlocked": false,
                "Primary": true,
                "PrivateIpAddress": "192.168.0.13",
                "PublicIpAddress": "",
                "State": "AVAILABLE"
              },
              {
                "Description": "",
                "IsWanIpBlocked": false,
                "Primary": false,
                "PrivateIpAddress": "192.168.0.15",
                "PublicIpAddress": "",
                "State": "AVAILABLE"
              },
              {
                "Description": "",
                "IsWanIpBlocked": false,
                "Primary": false,
                "PrivateIpAddress": "192.168.0.17",
                "PublicIpAddress": "",
                "State": "AVAILABLE"
              },
              {
                "Description": "",
                "IsWanIpBlocked": false,
                "Primary": false,
                "PrivateIpAddress": "192.168.0.24",
                "PublicIpAddress": "",
                "State": "AVAILABLE"
              }
            ],
            "State": "AVAILABLE",
            "SubnetId": "subnet-nao8lfro",
            "VpcId": "vpc-mrzkofih",
            "Zone": "ap-guangzhou-2"
          }
        ],
        "RequestId": "5cf1a813-d4f8-4e0c-8f90-c155a84a3ea1",
        "TotalCount": 1
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

    错误码 描述
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameterValue.Malformed 入参格式不合法。
    ResourceNotFound 资源不存在。