全部產品
Search
文件中心

Elasticsearch:InstallUserPlugins

更新時間:Jan 16, 2025

調用InstallUserPlugins,安裝使用者自訂的已經上傳至Elasticsearch控制台的外掛程式。

說明 安裝自訂外掛程式功能內部升級中,暫停使用。如果您急需使用該功能,請通過工單聯絡我們。

調試

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

要求標頭

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

請求文法

POST /openapi/instances/{InstanceId}/plugins/user/actions/install HTTP/1.1

請求參數

名稱

類型

位置

是否必選

樣本值

描述

InstanceId String Path es-cn-i7m27ausp001l****

執行個體ID。

String Body [ {"name": "pluginName1.zip"}, {"name": "pluginName2.zip"} ]

指定自訂外掛程式列表。

RequestBody

RequestBody中還需填入以下參數,用來指定自訂外掛程式列表。

參數

類型

是否必須

樣本值

描述

RequestBody

Array

└ name

String

pluginName1.zip

使用者自訂的已經上傳至Elasticsearch控制台的外掛程式。

└表示子參數。

樣本如下:

[
    {"name": "pluginName1.zip"},
    {"name": "pluginName2.zip"}
]

返回資料

名稱

類型

樣本值

描述

RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6F*****

請求ID。

Result Array of String ["pluginName1.zip", "pluginName2.zip"]

請求安裝的外掛程式列表。如果安裝失敗,系統會返回對應的錯誤碼,請參考錯誤碼進行問題定位。

樣本

請求樣本

POST /openapi/instances/[es-cn-i7m27ausp001l****]/plugins/user/actions/install HTTP/1.1
公用要求標頭
```
[
    {"name": "pluginName1.zip"},
    {"name": "pluginName2.zip"}
]

正常返回樣本

JSON格式

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

{
  "RequestId" : "5FFD9ED4-C2EC-4E89-B22B-1ACB6F*****",
  "Result" : "[\"pluginName1.zip\", \"pluginName2.zip\"]"
}

錯誤碼

HttpCode

錯誤碼

錯誤資訊

描述

400 InstanceActivating Instance is activating. 執行個體目前處於生效中。
400 InstanceNotFound The instanceId provided does not exist. 執行個體找不到,請核對執行個體狀態。

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