All Products
Search

This Product

    Elasticsearch:Modify a scenario-base configuration template

    Document Center

    Elasticsearch:Modify a scenario-base configuration template

    Last Updated:Dec 06, 2025

    Alibaba Cloud Elasticsearch provides a scenario-based configuration feature that lets you use templates to optimize your cluster and index configurations based on your business scenario. You can select a template for a scenario, such as general, data analytics, database acceleration, or search, and then modify the supported configurations. This helps prevent cluster exceptions and performance issues caused by incorrect settings. This topic describes how to modify a scenario-based configuration template.

    Scope

    This feature is available only for existing v2 architecture clusters.

    Background

    Before you modify a scenario-based configuration template, note the following:

    • The supported scenario-based configuration templates vary based on the instance version and type. The templates available in the console are the definitive list.

      For instances where the Indexing Service is enabled, only the log scenario is supported.

    • The system-recommended index template is named aliyun_default_index_template. This template has a low order priority and does not affect the templates that you create.

    • The policy defined in the system-recommended index lifecycle template is named aliyun_default_ilm_policy. By default, this policy is applied to the aliyun_default_index_template template.

    • When you purchase a new instance, you can select a scenario on the purchase page. The default scenario is General for Commercial Edition instances and Log for Kernel-enhanced Edition instances. After the instance is purchased, the configurations of the corresponding template are automatically applied to the cluster.

      Note

      If the Scenario-based Configuration Template is set to Disabled, you can manually enable it by following the steps below. After enabling the template, you must submit it to apply the configuration to the cluster.

    • Modifying a scenario-based template is equivalent to running the PUT _template/aliyun_default_index_template command. This operation does not trigger an instance restart and does not affect the status of your indexes or cluster.

      Note

      Because management versions of ES instances vary, the scenario-based configurations available in the console may also vary. If the scenario-based configuration feature is not available for your ES instance in the console, you can use the ES API (PUT _template/aliyun_default_index_template) to configure the template.

    Procedure

    1. Log on to the Alibaba Cloud Elasticsearch console.

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

    3. Navigate to the target instance.

      1. In the top navigation bar, select a resource group and a region.

      2. On the Elasticsearch Clusters page, click the ID of the target instance.

    4. In the left navigation pane, click Cluster Configuration.

    5. In the Scenario-based Configuration section, click Modify next to Scenario General.

      修改场景化模板

    6. In the Modify Scenario-based Configuration dialog box, select a Scenario-based Template and click OK.

      Note

      Modifying the scenario-based configuration is a dynamic operation. You do not need to restart the cluster.

    7. Modify the scenario-based configuration template.

      修改场景配置

      • Dynamic cluster configuration: Modifies cluster settings dynamically. This is equivalent to running the PUT /_cluster/settings command. For more information, see Cluster update settings.

      • Index template configuration: Defines a template that is automatically applied when a new index is created. The template is applied only at the time of index creation. Changes to the template do not affect existing indexes. This is equivalent to running the PUT _template/aliyun_default_index_template command. For more information, see Index templates.

      • Index lifecycle configuration: For instances of version 6.7.0 or later, you can enable the index lifecycle template. This is equivalent to running the PUT _ilm/policy/aliyun_default_ilm_policy command. For more information, see Setting up a new policy.

      The following steps describe how to modify the Index Template Configuration. The procedure is similar for other template configurations.

      1. Click Index Template Configuration.

      2. On the Index Template Configuration page, click Apply.

        一键应用模板

        The following features are provided:

        • Apply: Applies the recommended template from the right to the current configuration on the left. You can modify the configuration only after applying the template.

        • Compare: Compares the current configuration with the recommended template. This feature is available only after you modify the current configuration. You cannot edit the configuration while in comparison mode.

        • Reset: After you modify the configuration, click Reset to revert to the last applied configuration.

      3. In the Current Configuration section on the left, you can modify the configuration of the current template.

      4. After you modify the configuration, click Compare to view the differences between the modified and recommended configurations.

        查看对比

      5. Click Cancel.

    8. Click Submit.

      After you submit the changes, the modified configuration is applied to the cluster.