更新时间：2026-09-03 GMT+08:00

查询自定义词库状态

功能介绍

云搜索服务的词库用于对文本进行分词，使得一些特殊词语在分词的时候能够被识别出来，便于根据关键词搜索文本数据。例如，根据公司名称来查询；或者根据网络流行词来查询，如“喜大普奔”。也支持基于同义词词库，根据同义词搜索文本数据。CSS服务使用的分词器包括IK分词器和同义词分词器。IK分词器配备主库和停词词库；同义词分词器配备同义词词库。其中，IK分词器包含ik_max_word和ik_smart分词策略。同义词分词器使用的是ik_synonym分词策略。该接口用于查询自定义词库的加载状态。

调用方法

请参见如何调用API。

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/thesaurus

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID。获取方法请参见获取项目ID和名称。约束限制：不涉及取值范围：账户的项目ID。默认取值：不涉及
cluster_id	是	String	参数解释：指定需查询词库状态的集群ID。获取方法请参见获取集群ID。约束限制：不涉及取值范围：集群ID。默认取值：不涉及

请求参数

无

响应参数

状态码：200

表2 响应Body参数
参数	参数类型	描述
status	String	参数解释：自定义词库加载状态。取值范围： Init表示正在初始化。 Loaded表示加载成功。 Loading表示正在加载中。 Failed表示加载失败。 NeedReboot表示需要重启集群。 Undefined表示未定义。
bucket	String	参数解释：最近一次更新存放词库文件的OBS桶。取值范围：不涉及
mainObj	String	参数解释：主词词库文件对象。取值范围：不涉及
stopObj	String	参数解释：停词词库文件对象。取值范围：不涉及
synonymObj	String	参数解释：同义词词库文件对象。取值范围：不涉及
staticMainObj	String	参数解释：静态主词词库文件对象。取值范围：不涉及
staticStopObj	String	参数解释：静态主词词库文件对象。取值范围：不涉及
extraMainObj	String	参数解释： Extra主词词库文件对象。取值范围：不涉及
extraStopObj	String	参数解释： Extra停词词库对象。取值范围：不涉及
updateTime	String	参数解释：词库最近更新时间。取值范围：不涉及
updateDetails	String	参数解释：词库更新详情。取值范围：不涉及
clusterId	String	参数解释：指定配置自定义词库的集群ID。取值范围：不涉及
id	String	参数解释：词库的ID。取值范围：不涉及

请求示例

查询自定义词库的加载状态。

GET https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/thesaurus

响应示例

状态码：200

请求成功。

{
  "status" : "Loaded",
  "id" : "e766bd5a-79b0-4d1a-8402-fdeb017a36d1",
  "bucket" : "test-bucket",
  "mainObj" : "word/main.txt",
  "stopObj" : "word/stop.txt",
  "synonymObj" : "word/synonym.txt",
  "staticMainObj" : "Unused",
  "staticStopObj" : "Unused",
  "extraMainObj" : "Unused",
  "extraStopObj" : "Unused",
  "updateTime" : 1521184757000,
  "updateDetails" : "allinstancesareloadedsuccessfully.",
  "clusterId" : "ea244205-d641-45d9-9dcb-ab2236bcd07e"
}

状态码

状态码	描述
200	请求成功。
500	表明服务端能被请求访问到，但是不能理解用户的请求。

错误码

请参见错误码。

父主题： 词库管理