调用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. 实例找不到,请核对实例状态。

访问错误中心查看更多错误码。