接口请求域名: waf.intl.tencentcloudapi.com 。
查询关键词列表
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeLLMKeywordLibrary。 |
| Version | 是 | String | 公共参数,本接口取值:2018-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。 |
| Type | 是 | String | 词库类型筛选 枚举值: custom:自定义黑库 builtin:内置词库 all:全部词库 white:自定义白库 |
| Offset | 否 | Integer | 分页偏移量 取值范围:[0, +∞) 默认值:0 |
| Limit | 否 | Integer | 每页返回数量 取值范围:[1, 1000] 默认值:10 |
| By | 否 | String | 排序字段 枚举值: UpdateTime:按更新时间排序 CreateTime:按创建时间排序 Name:按名称排序 默认值:UpdateTime |
| Order | 否 | String | 排序方向 枚举值: ASC:升序 DESC:降序 默认值:DESC |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| LibList | Array of LLMKeywordLibrary | 关键词库列表 |
| Total | Integer | 词库总数 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
按更新时间降序查询自定义词库列表,每页10条
POST / HTTP/1.1
Host: waf.intl.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
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。
文档反馈