更新时间:2026-11-13 GMT+08:00
分享

分页查询词条 - ListWords

功能介绍

功能介绍:分页查询指定词库中的词条列表,支持按关键词模糊搜索、按规则编码和检测类别筛选。返回词条总数及词条详情(条目ID、关键词、规则编码、类别、更新时间)。

调用方法

请参见如何调用API。

授权信息

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,标识资源所属的华为云项目,用于隔离不同的租户资源。可通过用户控制台的“我的凭证”页面或调用IAM服务接口获取对应的项目ID

约束限制:

满足正则匹配"^[a-z0-9]{32}$"

取值范围:

由IAM服务接口返回,为固定长度的32个字符,由数字和字母组成

默认取值:

不涉及

lexicons_id

是

String

参数解释:

词库的ID,唯一的资源标识,用于定位要操作的具体词库。可通过调用创建词库接口的返回值获取,或通过查询词库列表接口获取

约束限制:

满足正则匹配"^[a-z0-9]{32}$"

取值范围:

字符类型,长度不超过64个字符

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释:

分页偏移

约束限制:

不涉及

取值范围:

0 ~ 1000

默认取值:

0

limit

否

Integer

参数解释:

每页数量限制

约束限制:

不涉及

取值范围:

1 ~ 1000

默认取值:

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-违法检测

  • RISKY-风险检测

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于鉴权和标识调用方身份。通过调用IAM服务“查询用户Token”接口获取,Token值为响应消息头中X-Subject-Token对应的值

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释:

词条数量

取值范围:

不涉及

items

Array of WordItemWithId objects

参数解释:

词条信息列表

取值范围:

不涉及

表5 WordItemWithId

参数

参数类型

描述

entry_id

String

参数解释:

词ID

取值范围:

不涉及

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-违法检测

  • RISKY-风险检测

updated_at

Long

参数解释:

更新时间,Unix时间戳,单位毫秒

取值范围:

0 ~ 9999999999999(Unix时间戳,单位毫秒)

请求示例

分页查询词库词条

/v1/da211edc7bac01a07182af742e04dc6d/content-check/lexicons/1d2e3f4a5b6c7d8e9f0a1b2c3d4e5f6a/words

响应示例

状态码:200

{
  "total" : 1,
  "items" : [ {
    "entry_id" : "5b6c7d8e9f0a1b2c3d4e5f6a7b8c9d0e",
    "keyword" : "未授权转载内容",
    "rule_code" : "SINGLE",
    "category" : "COPYRIGHT",
    "updated_at" : 1787392800000
  } ]
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档