帮你快速理解、总结文档立即下载
文档中心>边缘可用区>API 文档>网络相关接口>查询公网IP列表

查询公网IP列表

最近更新时间：2026-09-17 17:29:24
我的收藏

本页目录：

1. 接口描述

接口请求域名： edgezone.tencentcloudapi.com 。

查询用户的公网Ip信息，对于路由模式为Static的公网实例，会返回所有已申请的公网Ip信息，对于路由模式为Ospf和Bgp的公网实例，会直接返回网段信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribePublicIps。
Version 是 String 公共参数，本接口取值：2026-04-01。
Region 是 String 公共参数，详见产品支持的 地域列表。
NetworkInstanceId.N 否 Array of String 按公网实例 ID 过滤（子串匹配，多个值取并集）
示例值：["epn-dfghjkl", "epn-a1b2c3d4"]
ZoneId 否 String 按可用区/机房过滤
示例值：ap-beijing
Ip.N 否 Array of String 按 IP 过滤（子串匹配，多个值取并集）
示例值：["10.100.12.1", "10.100.13.2"]
State.N 否 Array of String 按状态过滤，可选值：InUse、Unbound（多个值取并集）
示例值：["Unbound", "InUse"]
Type.N 否 Array of String 按 IP 版本过滤，可选值：Ipv4、Ipv6（多个值取并集）
示例值：["ipv4", "ipv6"]
OrderByCreateTime 否 String 按创建时间排序，可选值：asc、desc（默认 desc）
示例值：asc
OrderByUpdateTime 否 String 按更新时间排序，可选值：asc、desc（优先级高于创建时间排序）
示例值：desc
Offset 否 Integer 分页偏移量，默认 0
示例值：0
Limit 否 Integer 每页数量，默认 20，最大 100
示例值：20

3. 输出参数

参数名称 类型 描述
TotalCount Integer 公网Ip总数
示例值：10
IpInfoSet Array of IpInfo 分配的公网 IP 地址列表
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询静态公网实例Ip信息

输入示例

POST / HTTP/1.1
Host: edgezone.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePublicIps
<公共请求参数>

{
    "ZoneId": "ap-beijing",
    "State": [
        "InUse"
    ],
    "Type": [
        "Ipv4"
    ],
    "Offset": 0,
    "Limit": 20
}

输出示例

{
    "Response": {
        "RequestId": "test-req-028",
        "TotalCount": 2,
        "IpInfoSet": [
            {
                "Ip": "10.0.0.200",
                "NetworkInstanceId": "epn-xxxxxxxx",
                "InstanceId": "ins-001",
                "State": "InUse",
                "Type": "Ipv4",
                "CreatedAt": "2026-04-07T00:00:00",
                "UpdatedAt": "2026-04-07T00:00:00"
            },
            {
                "Ip": "10.0.0.201",
                "NetworkInstanceId": "epn-xxxxxxxx",
                "InstanceId": "",
                "State": "Unbound",
                "Type": "Ipv4",
                "CreatedAt": "2026-04-07T00:00:00",
                "UpdatedAt": "2026-04-07T00:00:00"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
中国站