Help Center/ Document Database Service/ User Guide/ Parameter Template Management/ Modifying a Parameter Template
Updated on 2023-03-15 GMT+08:00
View PDF

Modifying a Parameter Template

You can modify parameters in custom parameter templates as needed to get the most out of DDS performance.

You can modify parameters in either of the following ways:

  • Directly modify the parameters of a specified instance.

    If you change a dynamic parameter value in a parameter template and save the change, the change takes effect immediately regardless of the Effective upon Reboot setting. If you modify static parameters on the Parameters page of an instance and save the modifications, the modifications take effect only after you manually restart the target instance.

  • Modify the parameters in a parameter template and apply the template to the instance.

    The changes only take effect after you apply the template to the instance. If you modify static parameters in a custom parameter template on the Parameter Template Management page and save the modifications, the modifications take effect only after you apply the parameter template to instances and manually restart the instances. For details about how to apply a parameter template to instances, see Applying a Parameter Template.

Precautions

  • You can change parameter values in custom parameter templates but cannot change the default parameter templates provided by the system. You can only click the name of a default parameter template to view its details.
  • If a custom parameter template is set incorrectly, the instance associated with the template may fail to start. You can re-configure the custom parameter template according to the configurations of the default parameter template.

Modifying Parameters of an Instance

  1. Log in to the management console.
  2. Click in the upper left corner and select a region and a project.
  3. Click in the upper left corner of the page and choose Databases > Document Database Service.
  4. In the navigation pane on the left, choose Instances. On the displayed page, click the DB instance whose parameters you wish to modify.
  5. In the navigation pane on the left, choose Parameters. On the displayed page, modify parameters as required.
  6. Modify parameters based on the DB instance type.

    • If the DB instance is a cluster instance, select mongos, shard, or config on the Parameters page and change the value of net.maxIncomingConnections, which indicates maximum number of concurrent connections that mongos or mongod can be connected.

      Enter net.maxIncomingConnections in the search box in the upper right corner of the page and click the search icon to search for this parameter.

    • If the DB instance is a read replica instance, change the value of net.maxIncomingConnections, which indicates maximum number of concurrent connections that mongos or mongod can be connected.

      Enter net.maxIncomingConnections in the search box in the upper right corner of the page and click the search icon to search for this parameter.

    • If the DB instance is a single node instance, change the value of net.maxIncomingConnections, which indicates maximum number of concurrent connections that mongos or mongod can be connected.

      Enter net.maxIncomingConnections in the search box in the upper right corner of the page and click the search icon to search for this parameter.

  7. Change the maximum number of connections based on the parameter value range and instance specifications. This default value depends on the DB instance specifications. This parameter is displayed as default before being set, indicating that the parameter value varies with the memory specifications. For details about the parameters, see Parameters.

    • To save the changes, click Save.
    • If you want to cancel the modifications, click Cancel.
    • If you want to preview the modifications, click Preview.

  8. After the parameters have been modified, click Change History to view parameter modification details. For details, see Viewing Change History of DB Instance Parameters.

    Check the value in the Effective upon Restart column. If it is set to:
    • Yes: If an instance status on the Instances page is Pending restart, the instance needs to be restarted to apply changes.
    • No: The changes are applied immediately.

Modifying Parameters in a Custom Parameter Template

  1. Log in to the management console.
  2. Click in the upper left corner and select a region and a project.
  3. Click in the upper left corner of the page and choose Databases > Document Database Service.
  4. In the navigation pane on the left, choose Parameter Templates.
  5. On the Parameter Templates page, click Custom Templates. Locate the target parameter template and click its name.
  6. Modify the required parameters.

    For parameter description details, see Parameters.
    • If you want to save the modifications, click Save.
    • If you want to cancel the modifications, click Cancel.
    • If you want to preview the modifications, click Preview.

  7. The modifications take effect only after you apply the parameter template to instances. For details, see Applying a Parameter Template.

    • After the parameters have been modified, click Change History to view parameter modification details. For details, see Viewing Change History of a Custom Parameter Template.
    • The change history page displays only the modifications of the last seven days.
    • For details about the parameter template statuses, see Parameter Template Status.
    • After modifying a parameter, view the associated instance status in the instance list. If Pending restart is displayed, restart the instance for the modification to take effect.