分页查询 IP 组中的 IP 列表

最近更新时间:2025-09-12 03:48:50

我的收藏

1. 接口描述

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

该接口用于分页查询指定 IP 组中的 IP 地址列表。当 IP 组中的 IP 地址数量超过 2000 个时,可以使用此接口进行分页查询,以获取完整的 IP 地址列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSecurityIPGroupContent。
Version String 公共参数,本接口取值:2022-09-01。
Region String 公共参数,此参数为可选参数。
ZoneId String 站点 ID。
GroupId Integer IP 组 ID。
Limit Integer 分页查询限制数目。默认值:2000,最大值:100000。
Offset Integer 分页查询偏移量。默认值:0。

3. 输出参数

参数名称 类型 描述
IPTotalCount Integer IP 组中正在生效的 IP 或网段个数。
IPList Array of String 满足查询条件的 IP 或网段列表。受 Limit 和 Offset 参数限制。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询 IP 组中的 IP 或网段内容

通过指定 GroupId 查询 IP 组中的 IP 或网段列表。如果 IP 或网段列表数量超过 100000,可以通过分页查询的方式逐步获取所有数据。

输入示例

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

{
    "ZoneId": "zone-nqicqhasui",
    "GroupId": 100121,
    "Limit": 1000,
    "Offset": 0
}

输出示例

{
    "Response": {
        "IPTotalCount": 5,
        "IPList": [
            "1.1.1.1",
            "1.2.3.1",
            "1.2.4.1",
            "1.5.3.1",
            "6.2.3.1"
        ],
        "RequestId": "ddf831fc-cf45-40fe-81b0-2d9cdd4c1bd6"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码