查询弹性公网IP列表

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

1. 接口描述

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

本接口 (DescribeAddresses) 用于查询一个或多个弹性公网IP(简称 EIP)的详细信息。

  • 如果参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的 EIP。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAddresses
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
AddressIds.N Array of String 标识 EIP 的唯一 ID 列表。EIP 唯一 ID 形如:eip-11112222。参数不支持同时指定AddressIdsFilters
Filters.N Array of Filter 每次请求的Filters的上限为10,Filter.Values的上限为5。参数不支持同时指定AddressIdsFilters。详细的过滤条件如下:
  • address-id - String - 是否必填:否 - (过滤条件)按照 EIP 的唯一 ID 过滤。EIP 唯一 ID 形如:eip-11112222。
  • address-name - String - 是否必填:否 - (过滤条件)按照 EIP 名称过滤。不支持模糊过滤。
  • address-ip - String - 是否必填:否 - (过滤条件)按照 EIP 的 IP 地址过滤。
  • address-status - String - 是否必填:否 - (过滤条件)按照 EIP 的状态过滤。取值范围:详见EIP状态列表
  • instance-id - String - 是否必填:否 - (过滤条件)按照 EIP 绑定的实例 ID 过滤。实例 ID 形如:ins-11112222。
  • private-ip-address - String - 是否必填:否 - (过滤条件)按照 EIP 绑定的内网 IP 过滤。
  • network-interface-id - String - 是否必填:否 - (过滤条件)按照 EIP 绑定的弹性网卡 ID 过滤。弹性网卡 ID 形如:eni-11112222。
  • is-arrears - String - 是否必填:否 - (过滤条件)按照 EIP 是否欠费进行过滤。(TRUE:EIP 处于欠费状态|FALSE:EIP 费用状态正常)
  • Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
    Limit Integer 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。

    3. 输出参数

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

    4. 示例

    示例1 使用AddressIds查询EIP

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeAddresses
    &AddressIds.0=eip-hxlqja90
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "AddressSet": [
          {
            "AddressId": "eip-hxlqja90",
            "AddressIp": "123.121.34.33",
            "AddressName": "test",
            "AddressStatus": "BINDED",
            "CreatedTime": "2017-09-12T07:52:00Z",
            "InstanceId": "ins-m2j0thu6",
            "IsArrears": false,
            "IsBlocked": false,
            "NetworkInterfaceId": null,
            "PrivateAddressIp": null
          }
        ],
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03",
        "TotalCount": 1
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameter 入参不合法。