UpdateSynonymsDicts - Elasticsearch

調用此介面時，請注意：

如果詞典檔案來源於OSS，需要確保OSS儲存空間為公用可讀。
如果已經上傳的詞典不加ORIGIN配置，調用此介面後，詞典檔案會被刪除。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

要求標頭

該介面使用公用要求標頭，無特殊要求標頭。請參見公用請求參數文檔。

請求文法

PUT /openapi/instances/[InstanceId]/synonymsDict HTTP/1.1

請求參數

名稱	類型	位置	是否必選	樣本值	描述
InstanceId	String	Path	是	es-cn-nif1q9o8r0008****	執行個體ID。
clientToken	String	Query	否	5A2CFF0E-5718-45B5-9D4D-70B3FF****	用於保證請求的等冪性。由用戶端產生該參數值，要保證在不同請求間唯一，最大不超過64個ASCII字元。

RequestBody

RequestBody中還需填入以下參數。

參數	類型	是否必須	樣本值	描述
name	String	是	dic_0.txt	上傳的詞典檔案名稱，必須為TXT類型。
ossObject	Array	否		OSS的開放隱藏檔描述。當sourceType為OSS時，必填。
└bucketName	String	否	search-cloud-test-cn-****	OSS儲存空間（Bucket）名稱。
└key	String	否	oss/dic_0.txt	詞典檔案在OSS Bucket中的儲存路徑。
sourceType	String	是	OSS	詞典檔案來源類型，可選值：OSS（使用OSS開放儲存）、ORIGIN（保留之前已經上傳的詞典）。注意：本地檔案需要先上傳至OSS，再通過OSS引用。如果已經完成上傳的詞典不加ORIGIN進行配置，會被系統刪除。
type	String	是	SYNONYMS	要更新的詞典類型，固定為SYNONYMS。

說明 └表示子參數。

樣本如下。


[
    {
        "name":"deploy_0.txt",
        "ossObject":{
            "bucketName":"search-cloud-test-cn-****",
            "key":"user_dict/dict_0.dic"
        },
        "sourceType":"OSS",
        "type":"SYNONYMS"
    },
    {
        "name":"SYSTEM_STOPWORD.txt",
        "sourceType":"ORIGIN",
        "type":"SYNONYMS"
    }
]

返回資料

名稱	類型	樣本值	描述
RequestId	String	7C5622CC-B312-426F-85AA-B0271*******	請求ID。
Result	Array of DictList		返回結果。
fileSize	Long	220	詞典檔案大小，單位：Byte。
name	String	deploy_0.txt	詞典檔案名稱。
sourceType	String	OSS	詞典檔案來源類型，支援： OSS：OSS開放儲存 ORIGIN：保留之前已經上傳的詞典
type	String	SYNONYMS	詞典類型，支援：SYNONYMS（同義字）。

樣本

請求樣本

PUT /openapi/instances/es-cn-nif1q9o8r0008****/synonymsDict HTTP/1.1
公用要求標頭
[
    {
        "name":"deploy_0.txt",
        "ossObject":{
            "bucketName":"search-cloud-test-cn-****",
            "key":"user_dict/dict_0.dic"
        },
        "sourceType":"OSS",
        "type":"SYNONYMS"
    },
    {
        "name":"SYSTEM_STOPWORD.txt",
        "sourceType":"ORIGIN",
        "type":"SYNONYMS"
    }
]

正常返回樣本

JSON格式

{
    "Result": [

        {
            "name":"deploy_0.txt",
            "fileSize":220,
            "sourceType":"OSS",
            "type":"SYNONYMS"
        },
        {
            "name":"SYSTEM_MAIN.txt",
            "fileSize":2782602,
            "sourceType":"ORIGIN",
            "type":"SYNONYMS"
        },
        {
            "name":"SYSTEM_STOPWORD.txt",
            "fileSize":132,
            "sourceType":"ORIGIN",
            "type":"SYNONYMS"
        }
    ],
    "RequestId": "1F7FE662-CCD8-474F-BA9B-A7E0792E****"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。