調用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. | 實例找不到,請核對實例狀態。 |
訪問錯誤中心查看更多錯誤碼。
文檔內容是否對您有幫助?