Web 应用防火墙获取地域封禁配置-API 文档-文档中心-腾讯云

1. 接口描述

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

获取地域封禁配置包括地域封禁开关，设置封禁的地区信息

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAreaBanAreas。
Version	是	String	公共参数，本接口取值：2018-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul 。
Domain	是	String	需要查询的域名示例值：www.test.com

3. 输出参数

参数名称	类型	描述
Data	DescribeAreaBanAreasRsp	回包内容示例值：{ "Status": "0", "Source": "custom", "Areas": [ "奥地利", "阿尔巴尼亚", "安道尔", "比利时", "保加利亚", "白俄罗斯", "波斯尼亚和黑塞哥维那", "捷克", "克罗地亚", "丹麦", "爱沙尼亚", "法国", "芬兰", "法罗群岛", "德国", "希腊", "直布罗陀", "匈牙利", "意大利", "爱尔兰", "冰岛", "马恩岛", "泽西岛", "立陶宛", "拉脱维亚", "卢森堡", "列支敦士登", "摩尔多瓦", "马其顿", "马耳他", "黑山", "摩纳哥", "荷兰", "挪威", "葡萄牙", "波兰", "瑞士", "瑞典", "西班牙", "罗马尼亚", "俄罗斯", "塞尔维亚", "斯洛文尼亚", "斯洛伐克", "圣马力诺", "英国", "乌克兰", "梵蒂冈" ], "JobType": "TimedJob", "JobDateTime": { "Timed": null, "Cron": null, "TimeTZone": "" }, "CronType": "-" }
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取地域封禁配置

输入示例

https://waf.tencentcloudapi.com/?Action=DescribeAreaBanAreas
&Domain=test.qcloudwaf.com
&<公共请求参数>

输出示例

{
    "Response": {
        "Data": {
            "Areas": [
                "新疆",
                "江西"
            ],
            "Status": "0"
        },
        "RequestId": "5ae9f295-4075-4472-8fd5-da69cc6ffa58"
    }
}

示例2 未设置封禁区域的场景

输入示例

https://waf.tencentcloudapi.com/?Action=DescribeAreaBanAreas
&Domain=www.test.com
&<公共请求参数>

输出示例

{
    "Response": {
        "Data": {
            "Status": "0",
            "Source": "custom",
            "Areas": [
                "山东"
            ],
            "JobType": "TimedJob",
            "JobDateTime": {
                "Timed": [
                    {
                        "StartDateTime": 0,
                        "EndDateTime": 0
                    }
                ],
                "Cron": null,
                "TimeTZone": "UTC+8"
            },
            "CronType": "week"
        },
        "RequestId": "7b9c4e2b-8282-4a6a-90cf-f64f2caef67a"
    }
}

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. 错误码

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

错误码	描述
InternalError	内部错误。
UnsupportedOperation	操作不支持。