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

DescribeIp6Addresses

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

1. 接口描述

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

该接口用于查询IPV6地址信息

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

接口更新时间：2020-04-01 23:43:27。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeIp6Addresses
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Ip6AddressIds 否 否 Array of String 标识 IPV6 的唯一 ID 列表。IPV6 唯一 ID 形如：eip-11112222。参数不支持同时指定Ip6AddressIds和Filters。
示例值：
Filters 否 否 Array of Filter 每次请求的Filters的上限为10，Filter.Values的上限为5。参数不支持同时指定AddressIds和Filters。详细的过滤条件如下：
  •  address-ip - String - 是否必填：否 - （过滤条件）按照 EIP 的 IP 地址过滤。
  •  network-interface-id - String - 是否必填：否 - （过滤条件）按照弹性网卡的唯一ID过滤。

    • 示例值：查看
    Offset 否 否 Int64 偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
    示例值：
    Limit 否 否 Int64 返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
    示例值：

    3. 输出参数

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

    4. 错误码

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

    错误码 描述
    InvalidParameterValue 参数值不合法。
    InvalidParameter 入参不合法。
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameterValue.LimitExceeded 参数值超出限制。
    InternalServerError 操作内部错误。
    InvalidAddressId.NotFound 指定的EIP不存在。