查询弹性公网IPv6列表

最近更新时间:2025-05-09 02:14:06

我的收藏

1. 接口描述

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

本接口(DescribeIPv6Addresses)用于查询一个或多个弹性公网 IPv6(简称 EIPv6)实例的详细信息。

  • 支持查询您在指定地域的弹性公网 IPv6 和传统弹性公网 IPv6 实例信息
  • 如果参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的 EIPv6。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeIPv6Addresses。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
IPv6AddressIds.N Array of String 标识 IPv6 的唯一 ID 列。可以使用DescribeIPv6Addresses接口获取IPv6AddressId。

- 传统弹性公网 IPv6 唯一 ID 形如:eip-11112222
- 弹性公网 IPv6 唯一 ID 形如:eipv6-11112222

注意:参数不支持同时指定IPv6AddressIdsFilters
示例值:["eipv6-kxjsieow"]
Filters.N Array of Filter 每次请求的Filters的上限为10,Filter.Values的上限为100。参数不支持同时指定IPv6AddressIdsFilters。详细的过滤条件如下:

- address-id - String - 是否必填:否 - (过滤条件)按照弹性公网IPv6的唯一ID过滤。
- public-ipv6-address - String - 是否必填:否 - (过滤条件)按照公网 IPv6 的 IP 地址过滤。
- network-interface-id - String - 是否必填:否 - (过滤条件)按照弹性网卡的唯一ID过滤。
- instance-id - String - 是否必填:否 - (过滤条件)按照绑定实例的唯一ID过滤。
- charge-type - String - 是否必填:否 - (过滤条件)按照计费类型过滤。
- private-ipv6-address - String - 是否必填:否 - (过滤条件)按照绑定的内网 IPv6 地址过滤。
- egress - String - 是否必填:否 - (过滤条件)按照出口过滤。
- address-type - String - 是否必填:否 - (过滤条件)按照IPv6类型 进行过滤。可选值:'EIP6':传统弹性公网 IPv6,'EIPv6':弹性公网 IPv6,'WanIPv6':普通公网 IPv6,'HighQualityEIPv6':精品弹性公网 IPv6。默认值是'EIPv6'。
- address-isp - String - 是否必填:否 - (过滤条件)按照 运营商类型 进行过滤。可选值:'BGP':常规BGP,'CMCC':移动,'CUCC':联通, 'CTCC':电信。
- address-status - String - 是否必填:否 - (过滤条件)按照 EIP 的状态过滤。状态包含:'CREATING':创建中,'BINDING':绑定中,'BIND':已绑,'UNBINDING':解绑中,'UNBIND':未绑定,'OFFLINING':下线中,'BIND_ENI':绑定了ENI,'PRIVATE':仅开通内网的IPv6。
- address-name - String - 是否必填:否 - (过滤条件)按照 EIP 名称过滤。不支持模糊过滤。
- tag-key - String - 是否必填:否 - (过滤条件)按照标签键进行过滤。
- tag-value - String - 是否必填:否 - (过滤条件)按照标签值进行过滤。
- tag:tag-key - String - 是否必填:否 - (过滤条件)按照标签键值对进行过滤。tag-key使用具体的标签键进行替换。
Traditional Boolean 是否查询传统型IPv6地址信息。可选值:
  • True:查询传统型IPv6地址信息
  • False:不查询传统型IPv6地址信息

  • 默认值:False
    示例值:False
    Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
    示例值:0
    Limit Integer 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
    示例值:20

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的 IPv6 数量。
    示例值:1
    AddressSet Array of Address IPv6 详细信息列表。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 根据IPv6AddressIds查询IPv6信息

    根据IPv6AddressIds查询IPv6信息。

    输入示例

    POST / HTTP/1.1
    Host: vpc.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeIPv6Addresses
    <公共请求参数>
    
    {
        "IPv6AddressIds": [
            "eipv6-11112222"
        ]
    }

    输出示例

    {
        "Response": {
            "TotalCount": 0,
            "AddressSet": [
                {
                    "AddressId": "eipv6-11112222",
                    "AddressName": "demo",
                    "AddressStatus": "BIND",
                    "AddressIp": "2402:4e00:1200:310d:0:9c6a:ffde:f722",
                    "InstanceId": "ins-qfuu0g3x",
                    "CreatedTime": "2020-09-22T00:00:00+00:00",
                    "NetworkInterfaceId": "eni-gl7hf76q",
                    "PrivateAddressIp": "2402:4e00:1200:310d:0:9c6a:ffde:f722",
                    "IsArrears": true,
                    "IsBlocked": true,
                    "IsEipDirectConnection": true,
                    "AddressType": "EIP6",
                    "CascadeRelease": true,
                    "EipAlgType": {
                        "Ftp": true,
                        "Sip": true
                    },
                    "InternetServiceProvider": "BGP",
                    "LocalBgp": true,
                    "Bandwidth": 1,
                    "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
                    "TagSet": [
                        {
                            "Key": "name",
                            "Value": "Sam"
                        }
                    ],
                    "DeadlineDate": "2020-09-22",
                    "InstanceType": "CVM",
                    "Egress": "CENTER_EGRESS_1"
                }
            ],
            "RequestId": "95eb79b9-2e72-45b1-a1ac-03138778521a"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidAddressId.NotFound 指定的EIP不存在。
    InvalidParameter 参数错误。
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameter.InvalidFilter 该过滤规则不合法。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.LimitExceeded 参数值超出限制。
    InvalidParameterValue.Malformed 入参格式不合法。