租户端 网络 私有网络（VPC） 弹性公网IP相关接口 DescribeAddresses

DescribeAddresses

最近更新时间: 2024-12-21 13:01:33

1. 接口描述

接口请求域名： vpc.api3.gsesgpucloud.com。

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

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

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

接口更新时间：2023-01-05 19:39:59。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeAddresses
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
AddressIds 否 否 Array of String 标识 EIP 的唯一 ID 列表。EIP 唯一 ID 形如：eip-11112222。参数不支持同时指定AddressIds和Filters。
示例值：
Filters 否 否 Array of Filter 每次请求的Filters的上限为10，Filter.Values的上限为5。参数不支持同时指定AddressIds和Filters。详细的过滤条件如下：
  •  address-id - String - 是否必填：否 - （过滤条件）按照 EIP 的唯一 ID 过滤。EIP 唯一 ID 形如：eip-11112222。
  •  dedicated-cluster-id - String - 是否必填：否 - （过滤条件）按照 CDC 的唯一 ID 过滤。CDC 唯一 ID 形如：cluster-11112222。
  •  address-name - String - 是否必填：否 - （过滤条件）按照 EIP 名称过滤。不支持模糊过滤。
  •  address-ip - String - 是否必填：否 - （过滤条件）按照 EIP 的 IP 地址过滤。
  •  address-status - String - 是否必填：否 - （过滤条件）按照 EIP 的状态过滤。状态包含：'CREATING'，'BINDING'，'BIND'，'UNBINDING'，'UNBIND'，'OFFLINING'，'BIND_ENI'。
  •  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 处于欠费状态
    		•
    Offset 否 否 Int64 偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
    示例值：
    Limit 否 否 Int64 返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
    示例值：
    ContainsCdc 否 否 Array of String 查询结果是否要包含CDC内的EIP信息, ALL:包含所有的EIP;NO_CDC:不包含CDC内的EIP, ONLY_CDC:只包含CDC内的EIP.
    示例值：

    3. 输出参数

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

    4. 错误码

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

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