Files

zhengxiu d48ac439de css api 25.1.0 version

Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: zhengxiu <zhengxiu@huawei.com>
Co-committed-by: zhengxiu <zhengxiu@huawei.com>

2025-05-28 09:20:51 +00:00

12 KiB

Raw Blame History

Querying the Status of a Custom Word Dictionary

Function

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

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints: N/A Options: For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Default value: N/A
cluster_id	Yes	String	Parameter description: ID of the cluster whose word dictionary status you want to query Constraints: N/A Options: For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Default value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
status	String	Parameter description: Loading status. Options: Init indicates initialization is in progress. Loaded indicates that the loading succeeded. Loading indicates that the loading is in progress. Failed indicates that the loading failed. NeedReboot indicates that a cluster restart is required. Undefined indicates an undefined state.
bucket	String	Parameter description: The OBS bucket that stores the word dictionary file that is last updated.
mainObj	String	Parameter description: Main word dictionary file
stopObj	String	Parameter description: Stop word dictionary file.
synonymObj	String	Parameter description: Synonym dictionary file.
staticMainObj	String	Parameter description: Static main word dictionary file
staticStopObj	String	Parameter description: Static main word dictionary file
extraMainObj	String	Parameter description: Extra main word dictionary file
extraStopObj	String	Parameter description: Extra stop word dictionary
updateTime	String	Parameter description: Latest update time of a dictionary.
updateDetails	String	Parameter description: Update details.
clusterId	String	Parameter description: ID of the cluster where a custom word dictionary you want to configure.
operateStatus	String	Parameter description: Operation status.
id	String	Parameter description: ID of the word dictionary.

Example Requests

Query the loading status of a custom word dictionary.

GET https://{Endpoint}/v1.0/{project_id}/clusters/{cluster_id}/thesaurus

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",
  "staticMainObj" : "Unused",
  "staticStopObj" : "Unused",
  "extraMainObj" : "Unused",
  "extraStopObj" : "Unused",
  "updateTime" : 1521184757000,
  "updateDetails" : "allinstancesareloadedsuccessfully.",
  "clusterId" : "ea244205-d641-45d9-9dcb-ab2236bcd07e"
}

Status Codes

Status Code	Description
200	Request succeeded.
500	The server is able to receive but unable to understand the request.

Error Codes

See Error Codes.

Parent topic: Word Dictionary Management

12 KiB Raw Blame History