Call the InstallLogstashSystemPlugin to install the plug-in.

Note the following before calling this interface:

The plug-ins to be installed must be included in Alibaba Cloud Logstash Built-in plug-ins, external open source plug-ins are not supported.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request header

This operation uses only common request headers. For more information, see Common parameters.

Request syntax

POST /openapi/logstashes/[InstanceId]/plugins/system/actions/install HTTPS|HTTP

Request parameters

Parameter Type Required Example Description
InstanceId String Yes ls-cn-oew1qbgl****

The ID of the instance.

clientToken String No 5A2CFF0E-5718-45B5-9D4D-70B3FF****

A unique token generated by the client to guarantee the idempotency of the request. The value of this parameter is generated by the client and is unique among different requests. The maximum length is 64 ASCII characters.


Enter the name of the plug-in to be installed in the format of ["pluginName1","pluginName2",...,"pluginNamen"] , as shown in the following example.


Response parameters

Parameter Type Example Description
RequestId String F99407AB-2FA9-489E-A259-40CF6DCC4****

The ID of the request.

Result List ["logstash-input-datahub", "logstash-input-maxcompute"]

Returned results

  • true: installation succeeded
  • false: installation failed

The returned data also contains Headers parameter, which indicates that the returned header information.


Sample requests

POST /openapi/logstashes/ls-cn-oew1qbgl****/plugins/system/actions/install HTTP/1.1
common request header

Sample success responses

JSON Syntax

    "Result": [
    "RequestId": "93DE9165-49A9-455E-AD7E-64B6694F****",
    "Headers": {}

Error codes

HttpCode Error code Error message Description
400 InstanceNotFound The instanceId provided does not exist. The error message returned because the instance cannot be found. Check the status of the instance.

For a list of error codes, visit the API Error Center.