有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

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

查询安全 IP 组的配置信息,包括安全 IP 组的 ID、名称和内容。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSecurityIPGroup。
Version String 公共参数,本接口取值:2022-09-01。
Region String 公共参数,此参数为可选参数。
ZoneId String 站点 ID ,用于指定查询的站点范围。
GroupIds.N Array of Integer 指定安全 IP 组 ID。
  • 提供该参数时,仅查询指定 ID 的安全 IP 组配置;
  • 不传递参数时,返回站点下所有安全 IP 组信息。
  • 3. 输出参数

    参数名称 类型 描述
    IPGroups Array of IPGroup 安全 IP 组的详细配置信息。包含每个安全 IP 组的 ID 、名称和 IP / 网段列表信息。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询安全 IP 分组的配置信息

    查询指定站点中,安全 IP 分组的配置信息。

    输入示例

    POST / HTTP/1.1
    Host: xxx.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeInstances
    <公共请求参数>
    
    {
        "ZoneId": "zone-nqicqhasui"
    }

    输出示例

    {
        "Response": {
            "IPGroups": [
                {
                    "GroupId": 123,
                    "Name": "ExampleIpGroup",
                    "Content": [
                        "2.2.2.2",
                        "23.23.23.0/24"
                    ]
                }
            ],
            "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. 错误码

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