Updated on 2025-12-30 GMT+08:00

Managing Nacos Engine Configurations

Querying Nacos Engine Configurations

CSE Nacos allows you to query configurations by data ID, group, application, and label.

  1. Click the target Nacos instance.
  2. In the left navigation pane, choose Configuration Management > Configurations.
  3. In the filter box above the configuration list, filter configurations by data ID, group, application, and label, and click to display the configurations that meet the filter criteria.

Viewing Nacos Engine Configuration Details

You can view configuration details about a Nacos engine on the CSE console.

  1. Click the target Nacos instance.
  2. In the left navigation pane, choose Configuration Management > Configurations.
  3. Click the target data ID. On the Configuration Details page displayed, view the configuration details. In the Configuration Content area, click search to query the configurations.

Editing Nacos Engine Configurations

When the configuration is in a dark launch status, roll back or release the configuration first.

  1. Click the target Nacos instance.
  2. In the left navigation pane, choose Configuration Management > Configurations.
  3. Edit a configuration in either of the following methods:

    • Click Edit in the Operation column of the target data ID.
    • Click the target data ID. On the Configuration Details page displayed, click Edit.

  4. On the Edit Configuration page, modify the configuration content, format, description, application, and label. Click Release. The Configuration Content Comparison dialog box is displayed. You can view the differences between the historical and current versions.
  5. Click Release. The Edit Configuration page also provides dark launch. For details, see Managing Dark Launch of Nacos Engine Configurations.

Importing Nacos Engine Configurations

You can import a local ZIP configuration file on the console to simplify the process of creating configurations manually. To reuse configurations among development, test, and pre-release environments, or to migrate a Nacos engine across clouds or platforms, you can export the configurations of the production environment first and then import the configuration file to the target engine to initialize the configurations in batches. This shortens the environment setup. If the configurations are deleted or tampered with, or the Nacos cluster is faulty, you can import the backup configuration file to quickly rebuild the service configuration environment.

  • After importing the configuration file, the handling of existing configurations depends on the specified processing policy, such as terminating the import, skipping the conflicting configurations, or overwriting them.
  • Before importing the configuration file, back up the existing target environment configurations. Import the file incrementally, and verify core service configurations in a small scope before proceeding with batch imports.
  • If you need to modify the configurations, you are advised to import the exported configuration file to the target engine and modify the configurations on the console. For details, see Editing Nacos Engine Configurations.

  1. Click the target Nacos instance.
  2. In the left navigation pane, choose Configuration Management > Configurations.
  3. Click Import Configuration and set parameters by referring to the following table.

    Figure 1 Importing Configurations

    Parameter

    Description

    Same Configuration

    • Terminate: If a configuration is the same as that in the system, the import terminates.
    • Skip: During import, if a configuration is the same as that in the system, the configuration is skipped and other configurations are imported.
    • Overwrite: During import, if a configuration is the same as that in the system, the value of the configuration will be replaced.

    Configuration File

    Click Import and select the target file.

    The file size cannot exceed 2 MB. If the file is too large, divide it into smaller files and import them individually.

  4. Click Close.

    • If Same Configuration is Terminate, the Terminate dialog box will be displayed if a configuration is the same as that in the system during the import. Click OK to terminate the import.
    • If Same Configuration is Skip, the configuration that is the same as that in the system will be skipped during the import, and other configurations are imported. Then, a dialog box is displayed showing the imported configurations. Click OK.

Exporting Nacos Engine Configurations

Export Nacos configurations to a file (such as properties, YAML, or JSON) as offline backup storage to prevent data loss caused by Nacos service faults, misoperations, or configuration deletion by mistake. During engine migration, export the original engine configurations and import them to the new engine in batches, avoiding the trouble of manually rebuilding configurations.

  1. Click the target Nacos instance.
  2. In the left navigation pane, choose Configuration Management > Configurations.
  3. Select the target configuration and click Export.

    • Click Export All to export all configurations.
    • You are advised to export the configurations separately to ensure that the size of an exported configuration file does not exceed 2 MB.
    Figure 2 Exporting Configurations

  4. In the displayed dialog box, click Export.

Deleting Nacos Engine Configurations

  1. Click the target Nacos instance.
  2. In the left navigation pane, choose Configuration Management > Configurations.
  3. Delete a configuration in either of the following methods:

    • Click Delete in the Operation column of the target data ID.
    • Select the target data ID and click Delete above.

  4. Click OK.