All Products
Search

This Product

    Elasticsearch:Install or uninstall a built-in plug-in

    Document Center

    Elasticsearch:Install or uninstall a built-in plug-in

    Last Updated:Mar 26, 2026

    Alibaba Cloud Elasticsearch instances come with a set of preinstalled plug-ins listed in the Built-in Plug-ins list. The available plug-ins depend on your instance version. Install or remove them from the console as needed.

    For the full list of supported plug-ins, compatible versions, and available operations, see Plug-in configuration.

    Non-removable plug-ins

    Two plug-ins are Alibaba Cloud Elasticsearch extensions and cannot be removed:

    • analysis-ik: An IK analysis plug-in that extends the open source version with dynamic loading of dictionary files from Object Storage Service (OSS). It supports both cold and rolling updates for IK dictionaries. For details, see Use the IK analysis plug-in (analysis-ik).

    • elasticsearch-repository-oss: Extends the open source version with the ability to create and restore index snapshots using the OSS file system.

    Prerequisites

    Before you begin, ensure that you have:

    Install or remove a built-in plug-in

    Important

    Installing or removing a plug-in triggers a cluster restart. Perform this operation during off-peak hours. Before removing a plug-in, confirm that no index references it. If an index still references the plug-in when the cluster restarts, the restart may stutter. Removing a plug-in deletes it from the cluster.

    1. Log on to the Alibaba Cloud Elasticsearch console.

    2. In the left navigation pane, click Elasticsearch Clusters.

    3. Navigate to the target cluster.

      1. In the top navigation bar, select the resource group and region where the cluster resides.

      2. On the Elasticsearch Clusters page, find the cluster and click its ID.

    4. In the left navigation pane, choose Configuration and Management > Plug-in Configuration.

    5. In the Built-in Plug-ins list, find the target plug-in and click Install or Remove in the Actions column.

    6. In the dialog box, review the precautions and click OK to confirm. The cluster restarts immediately after you confirm.

    7. In the Tasks list, monitor the restart progress. The plug-in installation or removal is complete when the restart succeeds.

    API reference