調用UpdateHotIkDicts，熱更新阿里云Elasticsearch實例的IK分詞插件，包括IK主分詞詞庫和IK停用詞詞庫。
調用此接口時，請注意：
- 如果詞典文件來源于OSS，需要確保OSS存儲空間為公共可讀。
- 如果已經上傳的詞典不加ORIGIN配置，調用此接口后，詞典文件會被刪除。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
請求頭
該接口使用公共請求頭，無特殊請求頭。請參見公共請求參數文檔。
請求語法
PUT /openapi/instances/{InstanceId}/ik-hot-dict HTTP/1.1請求參數
|
名稱 |
類型 |
位置 |
是否必選 |
示例值 |
描述 |
| InstanceId | String | Path | 是 | es-cn-oew1q8bev0002**** | 實例ID。 |
| clientToken | String | Query | 否 | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** | 用于保證請求的冪等性。由客戶端生成該參數值，要保證在不同請求間唯一，最大不超過64個ASCII字符。 |
| String | Body | 否 | 請參見RequestBody中的示例 | RequestBody |
RequestBody
RequestBody中還需填入以下參數。
參數 |
類型 |
是否必須 |
示例值 |
描述 |
name |
String |
是 |
dic_0.dic |
上傳的詞典文件名稱。 |
ossObject |
Array |
是 |
OSS的開放存儲文件描述。當sourceType為OSS時，必填。 |
|
└bucketName |
String |
是 |
search-cloud-test-cn-**** |
OSS存儲空間（Bucket）名稱。 |
└key |
String |
是 |
oss/dic_0.dic |
詞典文件在OSS Bucket中的存儲路徑。 |
sourceType |
String |
是 |
OSS |
詞典文件來源類型，可選值：OSS（使用OSS開放存儲）、ORIGIN（保留之前已經上傳的詞典）。 注意： 本地文件需要先上傳至OSS，再通過OSS引用。 如果之前已經完成上傳的詞典不加ORIGIN進行配置，會被系統刪除。 |
type |
String |
是 |
MAIN |
要更新的詞典類型。可選值：MAIN（IK主分詞詞庫）、STOP（IK停用詞庫）。 |
- └表示子參數。
- RequestBody要添加全量API參數。例如，添加停用詞時，默認或已安裝詞庫中的詞典文件都需要寫入RequestBody，以下示例中
"sourceType":"ORIGIN"就是存量詞典文件。
[
{
"name":"deploy_0.dic",
"ossObject":{
"bucketName":"search-cloud-test-cn-****",
"key":"user_dict/dict_0.dic"
},
"sourceType":"OSS",
"type":"MAIN"
},
{
"name":"deploy_2.dic",
"ossObject":{
"bucketName":"search-cloud-test-cn-****",
"key":"user_dict/dict_2.dic"
},
"sourceType":"OSS",
"type":"STOP"
},
{
"name":"SYSTEM_MAIN.dic",
"sourceType":"ORIGIN",
"type":"MAIN"
},
{
"name":"SYSTEM_STOPWORD.dic",
"sourceType":"ORIGIN",
"type":"STOP"
}
]
返回數據
名稱 |
類型 |
示例值 |
描述 |
| RequestId | String | 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1**** | 請求ID。 |
| Result | Array of DictList | 返回結果。 |
|
| fileSize | Long | 6 | 詞典文件大小，單位：Byte。 |
| sourceType | String | OSS | 詞典文件來源類型，支持：
|
| name | String | deploy_0.dic | 詞典文件名。 |
| type | String | MAIN | 詞典類型，支持：
|
示例
請求示例
PUT /openapi/instances/es-cn-oew1q8bev0002****/ik-hot-dict HTTP/1.1
公共請求頭
[
{
"name":"deploy_0.dic",
"ossObject":{
"bucketName":"search-cloud-test-cn-****",
"key":"user_dict/dict_0.dic"
},
"sourceType":"OSS",
"type":"MAIN"
},
{
"name":"deploy_2.dic",
"ossObject":{
"bucketName":"search-cloud-test-cn-****",
"key":"user_dict/dict_2.dic"
},
"sourceType":"OSS",
"type":"STOP"
},
{
"name":"SYSTEM_MAIN.dic",
"sourceType":"ORIGIN",
"type":"MAIN"
},
{
"name":"SYSTEM_STOPWORD.dic",
"sourceType":"ORIGIN",
"type":"STOP"
}
]正常返回示例
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Result" : [ {
"name" : "deploy_0.dic",
"ossObject" : {
"bucketName" : "search-cloud-test-cn-****",
"key" : "user_dict/dict_0.dic"
},
"sourceType" : "OSS",
"type" : "MAIN"
}, {
"name" : "deploy_2.dic",
"ossObject" : {
"bucketName" : "search-cloud-test-cn-****",
"key" : "user_dict/dict_2.dic"
},
"sourceType" : "OSS",
"type" : "STOP"
}, {
"name" : "SYSTEM_MAIN.dic",
"sourceType" : "ORIGIN",
"type" : "MAIN"
}, {
"name" : "SYSTEM_STOPWORD.dic",
"sourceType" : "ORIGIN",
"type" : "STOP"
} ],
"RequestId" : "E1F6991B-1F77-47EA-9666-593F11E3****"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。