本文提供了在自定义文本库中模糊搜索关键词的具体接口及参数，帮助您通过API接口自主管理您的文本库。您通过API接口管理的文本库可用于文本反垃圾检测，该方式与内容安全控制台上的自定义文本库功能完全一致。

使用说明

业务接口：DescribeKeyword

您可以调用该接口在指定文本库中以分页方式搜索关键词。关于如何构造HTTP请求，请参见请求结构；您也可以直接选用已构造好的HTTP请求，更多信息，请参见SDK概览。

计费信息：该接口为免费接口。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。

请求参数

关于在请求中必须包含的公共请求参数，请参见公共参数。

请求body是一个结构体，结构说明如下：
名称 类型 是否必选 示例值 描述
KeywordLibId Integer 是 2147 文本库主键ID。您可以通过获取文本库列表接口获取该主键ID。更多内容，请参见获取文本库列表。
Keyword String 否 你好 要搜索的关键词，支持模糊匹配。
说明 如果不指定该参数，则返回该文本库中所有关键词。
TotalCount Integer 否 1000 返回关键词数。
CurrentPage String 否 1 返回的当前分页。
PageSize Integer 否 20 返回的分页大小，即每个分页显示的关键字数量。

返回数据

关于返回结果说明，请参见返回结果。
名称 类型 示例值 描述
TotalCount Integer 1000 返回关键词数。
CurrentPage String 1 返回的当前分页。
PageSize Integer 20 返回的分页大小，即每个分页显示的关键字数量。
KeywordList JSONArray 关键词列表。关于具体结构的描述，请参见KeywordList。
表 1. KeywordList
名称 类型 示例值 描述
Id Integer 1 关键词主键ID。
CreateTime String 2018-04-19 20:12:30 +0800 创建时间。
Keyword String 你好 关键词。
HitCount Integer 101 关键词的匹配命中次数。

示例

请求示例
http(s)://green.cn-shanghai.aliyuncs.com/?
Action=DescribeKeyword&ServiceModule=open_api
&<公共请求参数>
{
  "KeywordLibId": "2147",
}
返回示例
{
  "code": 200,
  "requestId": "@guid",
  "data": {
    "TotalCount": 1000,
    "PageSize": 20,
    "CurrentPage": 1,
    "KeywordList": [
      {
        "Keyword": "你好",
        "HitCount": 101,
        "CreateTime": "2018-04-19 20:12:30 +0800",
        "Id": 1
      },
      {
        "Keyword": "测试",
        "HitCount": 102,
        "CreateTime": "2018-04-19 20:12:30 +0800",
        "Id": 2
      }
    ]
  }
}