帮你快速理解、总结文档立即下载
文档中心>API 中心>云防火墙>访问控制相关接口>IPS规则查询接口新

IPS规则查询接口新

最近更新时间：2026-07-24 01:27:03

我的收藏

本页目录：

1. 接口描述

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

IPS规则查询接口新

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeIpsRuleListNew。
Version 是 String 公共参数，本接口取值：2019-09-04。
Region 否 String 公共参数，本接口不需要传递此参数。
Limit 是 Integer 每页条数
示例值：20
Offset 是 Integer 偏移值
示例值：0
Index 否 String 需要查询的索引，特定场景使用，可不填
示例值：vpc_rule
Filters.N 否 Array of CommonFilter 过滤条件组合
Order 否 String desc：降序；asc：升序。根据By字段的值进行排序，这里传参的话则By也必须有值
示例值：desc
By 否 String 排序所用到的字段
示例值：id

3. 输出参数

参数名称 类型 描述
Total Integer 总条数
示例值：1
Data Array of IpsRuleDetailNew 规则详情
ReturnCode Integer 返回状态码 0 成功 非0不成功
示例值：0
ReturnMsg String 返回信息 success 成功 其他 不成功
示例值：success
Category Array of String 字段类型
注意：此字段可能返回 null，表示取不到有效值。
示例值：["a","b","c"]
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 IPS规则查询接口

输入示例

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

{
    "Filters": [
        {
            "Name": "Protocol",
            "Values": [
                "ANY",
                "TCP",
                "ICMP"
            ],
            "OperatorType": 9
        }
    ],
    "Limit": 10,
    "Offset": 0,
    "Order": "desc",
    "By": "sequence"
}

输出示例

{
    "Response": {
        "ReturnMsg": "xx",
        "ReturnCode": 0,
        "Data": [
            {}
        ],
        "Category": [
            "a",
            "b",
            "c"
        ],
        "RequestId": "xx",
        "Total": 1
    }
}

示例2 规则列表最新调用示例

规则列表最新调用示例

输入示例

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

{
    "Limit": 1,
    "Offset": 0
}

输出示例

{
    "Response": {
        "Category": [
            "SQL注入攻击",
            "web攻击",
            "XSS攻击",
            "一般攻击",
            "信息泄露",
            "已知弱点",
            "恶意文件下载",
            "恶意机器人检测",
            "恶意调用",
            "木马",
            "横向移动",
            "漏洞利用",
            "漏洞利用攻击",
            "网络攻击",
            "网络爆破"
        ],
        "Data": [
            {}
        ],
        "RequestId": "b775e058-734b-4de8-ac54-66f199d5ba88",
        "ReturnCode": 0,
        "ReturnMsg": "success",
        "Total": 3512
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InvalidParameter 参数错误。
LimitExceeded 超过配额限制。
UnauthorizedOperation 未授权操作。
中国站