調用ListDicts,用于返回指定類型的詞典詳情以及簽名生成的公網可下載鏈接。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求頭
該接口使用公共請求頭,無特殊請求頭。請參見公共請求參數文檔。
請求語法
GET /openapi/instances/[InstanceId]/dicts HTTP/1.1
請求參數
名稱 | 類型 | 位置 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|---|
analyzerType | String | Query | 是 | IK |
詞典類型,支持:
|
InstanceId | String | Path | 是 | es-cn-0ju29ifnc0005**** |
實例ID。 |
name | String | Query | 否 | SYSTEM_MAIN.dic |
篩選指定的文件名稱。 |
說明 每種elasticsearchAnalyzer下的詞典name是唯一的,即使IK的主分詞庫和停用分詞庫也不會存在相同name的詞典文件。
返回數據
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
Headers | Struct |
返回頭信息。 |
|
X-Total-Count | Integer | 1 |
總記錄數。 |
RequestId | String | 2937F832-F39E-41EF-89BA-B528342A2A3A |
請求ID。 |
Result | Array of Result |
返回的請求結果。 |
|
downloadUrl | String | http://test_bucket.oss-cn-hangzhou.aliyuncs.com/AliyunEs/test.dic?Expires=162573****&OSSAccessKeyId=LTAI*****V9&Signature=PNPO********BBGsJDO4V3VfU4sE%3D |
公網可下載鏈接。有效時長為90秒。 |
fileSize | Long | 2782602 |
詞典文件的字節數大小,單位:Byte。 |
name | String | SYSTEM_MAIN.dic |
詞典文件的文件名。 |
sourceType | String | ORIGIN |
固定值。 |
type | String | MAIN |
IK詞典的類型,取值含義如下:
|
示例
請求示例
GET /openapi/instances/es-cn-0ju29ifnc0005****/dicts HTTP/1.1
公共請求頭
{
"elasticsearchAnalyzer": "IK"
}
正常返回示例
JSON
格式
{
"Result": [
{
"name": "SYSTEM_MAIN.dic",
"fileSize": 2782602,
"downloadUrl": "http://test_bucket.oss-cn-hangzhou.aliyuncs.com/AliyunEs/test.dic?Expires=162573****&OSSAccessKeyId=LTAI*****V9&Signature=PNPO********BBGsJDO4V3VfU4sE%3D",
"sourceType": "ORIGIN",
"type": "MAIN"
}
],
"RequestId": "2937F832-F39E-41EF-89BA-B528342A2A3A",
"Headers": {
"X-Total-Count": 1
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。