All Products
Search
Document Center

Elasticsearch:ListDictInformation

更新時間:Sep 21, 2023

Queries and verifies the details of the dictionary object stored in Object Storage Service (OSS) when you upload the object to an Elasticsearch cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request headers.

Request syntax

GET /openapi/instances/{InstanceId}/dict/_info HTTP/1.1

Request parameters

Element

Type

Position

Required

Example

Description

InstanceId String Path Yes es-cn-n6w1o1x0w001c****

The instance ID.

bucketName String Query Yes search-cloud-test-cn-****

The name of the Object Storage Service (OSS) bucket that stores the dictionary file.

key String Query Yes oss/dic_0.dic

The path of the dictionary file in the OSS bucket.

analyzerType String Query No ALIWS

The category of the dictionary. Valid values:

  • IK (default):IK cold update dictionary
  • IK_HOT:IK hot update dictionary
  • SYNONYMS: synonym
  • ALIWS: Alibaba Dictionary

Response parameters

Element

Type

Example

Description

RequestId String 7C4334EA-D22B-48BD-AE28-08EE68******

The request ID.

Result Object

The response parameters.

type String STOP

The type of the dictionary. Valid values:

  • MAIN
  • STOP
fileSize Long 2202301

The size of the dictionary file. Unit: bytes.

ossObject Object

The details of the dictionary file.

key String oss/dict_0*.dic

The path of the dictionary file in the OSS bucket.

bucketName String es-osstest*

The name of the OSS bucket.

etag String 2ABAB5E70BBF631145647F6BE533****

The ETag value of the MD5 verification code of OSS.

Examples

Sample requests

GET /openapi/instances/es-cn-n6w1o1x0w001c****/dict/_info?bucketName=your-oss-bucket-name&key=test/dict.dic&analyzerType=ALIWS 
HTTP/1.1
Common request parameters

Sample success responses

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "7C4334EA-D22B-48BD-AE28-08EE68******",
  "Result" : {
    "fileSize" : 2202301,
    "type" : "STOP",
    "ossObject" : {
      "bucketName" : "es-osstest*",
      "etag" : "2ABAB5E70BBF631145647F6BE533****",
      "key" : "oss/dict_0*.dic"
    }
  }
}

Error code

For a list of error codes, see Service error codes.