Web 应用防火墙查看防护对象列表-API 文档-文档中心-腾讯云

1. 接口描述

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

查看防护对象列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeObjects。
Version	是	String	公共参数，本接口取值：2018-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-shanghai, ap-singapore, ap-tokyo 。
Filters.N	否	Array of FiltersItemNew	支持的过滤器: ObjectId: clb实例ID VIP: clb实例的公网IP InstanceId: waf实例ID Domain: 精准域名 Status: waf防护开关状态: 0关闭，1开启 ClsStatus: waf日志开关: 0关闭，1开启示例值：[ { "Name": "ObjectId", "Values": [ "lb-70mdt3ia" ], "ExactMatch": false } ]

3. 输出参数

参数名称	类型	描述
ClbObjects	Array of ClbObject	对象列表示例值：[ { "ApiStatus": 0, "BotStatus": 0, "ClsStatus": 0, "InstanceId": "waf_2kuil2ft02vqm7z3", "InstanceLevel": 3, "InstanceName": "gz-Default1", "IpHeaders": [ "spheader", "myheader" ], "NumericalVpcId": -1, "ObjectFlowMode": 1, "ObjectId": "lb-70mdt3it", "ObjectName": "zunhua-multi-test_pjk1", "PostCKafkaStatus": 0, "PostCLSStatus": 0, "PreciseDomains": [], "PrivateIp": [ "" ], "Proxy": 3, "PublicIp": [ "139.186.100.71" ], "Region": "ap-chongqing", "Status": 1, "Type": "CLB", "VirtualDomain": "lb-70mdt3it.clb-default.qcloudwaf.com", "Vpc": "vpc-jl1cw1e9", "VpcName": "Default-VPC" } ]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查看对象列表

输入示例

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

{
    "Filters": [
        {
            "Name": "Status",
            "Values": [
                "1"
            ],
            "ExactMatch": true
        }
    ]
}

输出示例

{
    "Response": {
        "ClbObjects": [
            {
                "ApiStatus": 0,
                "BotStatus": 0,
                "ClsStatus": 0,
                "InstanceId": "waf_2kuil2ft02vqm7z3",
                "InstanceLevel": 3,
                "InstanceName": "gz-Default1",
                "IpHeaders": [
                    "spheader",
                    "myheader"
                ],
                "NumericalVpcId": -1,
                "ObjectFlowMode": 1,
                "ObjectId": "lb-70mdt3it",
                "ObjectName": "zunhua-multi-test_pjk1",
                "PostCKafkaStatus": 0,
                "PostCLSStatus": 0,
                "PreciseDomains": [],
                "PrivateIp": [
                    "121.123.11.7"
                ],
                "Proxy": 3,
                "PublicIp": [
                    "139.186.100.71"
                ],
                "Region": "ap-chongqing",
                "Status": 1,
                "Type": "CLB",
                "VirtualDomain": "lb-70mdt3it.clb-default.qcloudwaf.com",
                "Vpc": "vpc-jl1cw1e9",
                "VpcName": "Default-VPC"
            }
        ],
        "RequestId": "6ceb784e-b440-4cac-81ee-0b87ffe81e6f"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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