Help Center> Cloud Search Service> API Reference> APIs Related to Word Dictionary Management> IK Word Splitting> Querying the Status of a Custom Word Dictionary
View PDF

Querying the Status of a Custom Word Dictionary

Function

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

URI

  • URI format 
    GET /v1.0/{project_id}/clusters/{cluster_id}/thesaurus
  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID. For details, see Obtaining the Project ID and Account ID.

    cluster_id

    Yes

    String

    ID of the cluster where the word dictionary status is queried.

Request

Example request

GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/thesaurus

Response

Table 1 Parameter description

Parameter

Type

Description

status

String

Loading status

  • Loaded indicates that a custom word dictionary is successfully loaded.
  • Loading indicates that a custom word dictionary is being loaded.
  • Failed indicates that a custom word dictionary fails to be loaded.

bucket

String

OBS bucket where word dictionary files are stored.

mainObj

String

Main word dictionary file object.

stopObj

String

Stop word dictionary file object.

synonymObj

String

Synonym word dictionary file object.

updateTime

String

Last word dictionary update time.

updateDetails

String

Update details.

clusterId

String

ID of the cluster where custom word dictionaries are to be configured.

operateStatus

String

Operating status.

id

String

ID of a word dictionary.

Example response

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

Status Code

Table 2 describes the status code.

Table 2 Status code

Status Code

Code

Status Code Description

200

OK

The request is processed successfully.

500

InternalServerError

The server is able to receive the request but it could not understand the request.
Parent topic: IK Word Splitting