調用InstallLogstashSystemPlugin,安裝外掛程式。
調用該介面前,請注意:
待安裝的外掛程式必須包含在阿里雲Logstash的系統預設外掛程式列表中,不支援外部開源外掛程式。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
要求標頭
該介面使用公用要求標頭,無特殊要求標頭。請參見公用請求參數文檔。
請求文法
POST /openapi/logstashes/{InstanceId}/plugins/system/actions/install HTTP/1.1
請求參數
| 名稱 | 類型 | 位置 | 是否必選 | 樣本值 | 描述 |
| InstanceId | String | Path | 是 | ls-cn-oew1qbgl**** | 執行個體ID。 |
| clientToken | String | Query | 否 | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** | 用於保證請求的等冪性。由用戶端產生該參數值,要保證在不同請求間唯一,最大不超過64個ASCII字元。 |
RequestBody
RequestBody中還需填入待安裝的外掛程式名稱,格式為["pluginName1","pluginName2",...,"pluginNamen"],樣本如下。
[
"logstash-input-datahub",
"logstash-input-maxcompute"
]
返回資料
| 名稱 | 類型 | 樣本值 | 描述 |
| RequestId | String | F99407AB-2FA9-489E-A259-40CF6DCC4**** | 請求ID。 |
| Result | Array of String | ["logstash-input-datahub", "logstash-input-maxcompute"] | 安裝成功的外掛程式列表。 |
返回資料中還包含Headers參數,表示返回頭資訊。
樣本
請求樣本
POST /openapi/logstashes/ls-cn-oew1qbgl****/plugins/system/actions/install?clientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
[
"logstash-input-datahub",
"logstash-input-maxcompute"
]
正常返回樣本
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Result" : [ "logstash-input-datahub", "logstash-input-maxcompute" ],
"RequestId" : "93DE9165-49A9-455E-AD7E-64B6694F****",
"Headers" : { }
}
錯誤碼
| HttpCode | 錯誤碼 | 錯誤資訊 | 描述 |
| 400 | InstanceActivating | Instance is activating. | 執行個體目前處於生效中。 |
| 400 | InstanceNotFound | The instanceId provided does not exist. | 執行個體找不到,請核對執行個體狀態。 |
訪問錯誤中心查看更多錯誤碼。