Web 应用防火墙查询自定义词库列表

1. 接口描述

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

查询关键词列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeLLMKeywordLibrary。
Version	是	String	公共参数，本接口取值：2018-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。
Type	是	String	词库类型筛选枚举值： custom：自定义黑库 builtin：内置词库 all：全部词库 white：自定义白库示例值：custom
Offset	否	Integer	分页偏移量取值范围：[0, +∞) 默认值：0 示例值：0
Limit	否	Integer	每页返回数量取值范围：[1, 1000] 默认值：10 示例值：10
By	否	String	排序字段枚举值： UpdateTime：按更新时间排序 CreateTime：按创建时间排序 Name：按名称排序默认值：UpdateTime 示例值：UpdateTime
Order	否	String	排序方向枚举值： ASC：升序 DESC：降序默认值：DESC 示例值：DESC

3. 输出参数

参数名称	类型	描述
LibList	Array of LLMKeywordLibrary	关键词库列表
Total	Integer	词库总数示例值：10
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询关键词库列表（分页排序）

按更新时间降序查询自定义词库列表，每页10条

输入示例

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

{
    "Type": "custom",
    "Offset": 0,
    "Limit": 10,
    "By": "UpdateTime",
    "Order": "DESC"
}

输出示例

{
    "Response": {
        "RequestId": "feca6493-7c4a-4103-a868-cc394d72ae8e",
        "LibList": [],
        "Total": 0
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

查询自定义词库列表

本页目录：