文档首页> 云搜索服务 CSS> API参考> 词库管理接口> 查询自定义词库状态
更新时间：2024-04-22 GMT+08:00
查看PDF

查询自定义词库状态

功能介绍

该接口用于查询自定义词库的加载状态。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见获取项目ID和名称。

cluster_id

是

String

指定需查询词库状态的集群ID。

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

status

String

加载状态。

  • Loaded表示加载成功。

  • Loading表示正在加载中。

  • Failed表示加载失败。

bucket

String

存放词库文件的OBS桶。

mainObj

String

主词库文件对象。

stopObj

String

停词词库文件对象。

synonymObj

String

同义词词库文件对象。

updateTime

String

词库最近更新时间。

updateDetails

String

更新详情。

clusterId

String

指定配置自定义词库的集群ID。

operateStatus

String

操作状态。

id

String

词库的ID。

请求示例

无

响应示例

状态码： 200

请求已成功。

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

状态码

状态码

描述

200

请求已成功。

500

表明服务端能被请求访问到，但是不能理解用户的请求。

错误码

请参见错误码。

父主题： 词库管理接口