Querying the Status of a Custom Word Dictionary

Function

This API is used to query the loading status of a custom word dictionary.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
cluster_id	Yes	String	ID of the cluster whose word dictionary status you want to query

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
status	String	Loading status. Loaded indicates that the loading succeeded. Loading indicates that the loading is in progress. Failed indicates that the loading failed.
bucket	String	OBS bucket for storing word dictionary files.
mainObj	String	Main word dictionary file.
stopObj	String	Stop word dictionary file.
synonymObj	String	Synonym dictionary file.
updateTime	String	Latest update time of a dictionary.
updateDetails	String	Update details.
clusterId	String	ID of the cluster where a custom word dictionary you want to configure.
operateStatus	String	Operation status.
id	String	ID of the word dictionary.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "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"
}