Alibaba Cloud Elasticsearch allows you to upload and install custom plug-ins.


If you want to upload a custom SQL plug-in, make sure that the xpack.sql.enabled parameter in the YML configuration files of your Elasticsearch cluster is set to false.

For more information, see YML configuration.


  1. Log on to the Alibaba Cloud Elasticsearch console.
  2. In the top navigation bar, select the region where your Alibaba Cloud Elasticsearch cluster resides.
  3. Find the target cluster and click its ID.
  4. In the left-side navigation pane, click Plug-ins.
  5. On the Plug-ins page, click the Custom Plug-ins tab. Click Upload.
    Upload custom plug-in page
    Warning Uploading a custom plug-in triggers a restart of the Elasticsearch cluster, and the plug-in may affect the stability of the cluster. Make sure that the custom plug-in is secure and available.
  6. In the Upload Plug-in dialog box, click Select files, or drag and drop files to this area. Then, select the custom plug-in that you want to upload.
    Upload Plug-in dialog box
    You can also drag and drop a custom plug-in file to this area and upload the plug-in. As shown in the preceding figure, the plug-in file Elasticsearch-sql- is added.
    Note You can repeat this step to add more custom plug-ins.
  7. Carefully read the agreement, select the check box, and click Upload.
    Your Alibaba Cloud Elasticsearch cluster is restarted when the plug-in is uploaded. After the cluster is restarted, you can check the plug-in on the Custom Plug-ins tab. The Status of the plug-in that you upload displays Installed. This indicates that the plug-in is successfully uploaded and installed.Plug-in uploaded
    Note The plug-in is not automatically updated with Elasticsearch. If you want to update the plug-in, you must manually upload a new version of the plug-in.

What to do next

If you no longer need the plug-in, find it on the Custom Plug-in tab and click Remove in the Actions column. For more information, see Install and remove a built-in plug-in.