文档首页/ 数据安全中心 DSC/ API参考/ API/ AI数据安全/ 分页查询词条 - ListWords
更新时间:2026-10-09 GMT+08:00
分享

分页查询词条 - ListWords

功能介绍

功能介绍:分页查询词条

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/content-check/lexicons/{lexicons_id}/words

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,字符长度32-32。

默认取值:

不涉及

lexicons_id

是

String

参数解释:

词库ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释:

分页偏移

约束限制:

不涉及

取值范围:

不涉及

默认取值:

0

limit

否

Integer

参数解释:

每页数量限制

约束限制:

不涉及

取值范围:

不涉及

默认取值:

10

keyword

否

String

参数解释:

关键词

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

rule_code

否

String

参数解释:

规则编码

约束限制:

不涉及

取值范围:

  • REGEX-正则

  • COMBINATION-组合检测

  • SINGLE-单机

默认取值:

不涉及

category

否

String

参数解释:

类别

约束限制:

不涉及

取值范围:

  • COPYRIGHT-版权检测

  • POLITIC-政治检测

  • GAMB-赌博检测

  • PORN-色情检测

  • DRUG-毒品检测

  • CREDIT-信贷检测

  • LOGIN-登录检测

  • VPN-虚拟专用网络

  • OTHER-其他

  • SEXUAL-色情检测

  • VIOLENCE-暴力检测

  • WEAPON-武器检测

  • POLITICS-政治检测

  • EXTREMISM-极端主义检测

  • ILLEGAL-违法检测

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

IAM服务查询用户Token接口为准

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

请求示例

分页查询词库词条

/v1/2b31ed520xxxxxxebedb6e57xxxxxxxx/content-check/lexicons/xxxx-xxxx-xxxx-xxxx/words

响应示例

状态码:200

{
  "total" : 2,
  "items" : [ {
    "entryId" : "5b6c7d8e9f0a1b2c3d4e5f6a7b8c9d0e",
    "keyword" : "未授权转载内容",
    "ruleCode" : "REGEX",
    "category" : "COPYRIGHT",
    "updatedAt" : 1787306400000
  }, {
    "entryId" : "6c7d8e9f0a1b2c3d4e5f6a7b8c9d0e1f",
    "keyword" : "侵权盗版素材",
    "ruleCode" : "SINGLE",
    "category" : "COPYRIGHT",
    "updatedAt" : 1787306400000
  } ]
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档