tencent cloud

Feedback

Applying Parameter Templates

Last updated: 2023-02-24 10:32:02
    Besides the system parameter templates provided by TencentDB for Redis, you can create custom parameter templates to configure parameters in batches as needed.
    You can apply a parameter template to configure and manage the parameters of a database engine. A template is like a container of the values of database engine parameters, which can be applied to one or more database instances.
    Parameter templates support the following features:
    Support the default parameter templates.
    Create custom templates by modifying the default parameters.
    Save parameter configurations as templates.
    Import parameters from templates to apply to one or more instances.
    Notes
    If the parameters in the template are updated, the instance parameters are not updated unless they are manually re-applied to the instances.
    You can apply the parameter changes to single or multiple instances by importing a template.

    Creating a custom parameter template

    To use your own database parameter template, you can create a parameter template, modify the parameter values, and apply the template to instances.
    1. Log in to the TencentDB for Redis console, select Parameter Templates on the left sidebar, and click Create Template.
    2. In the pop-up window, configure the following parameters and click Create and Set Parameters.
    Template Name: Enter a unique template name.
    Database Version: Select a database version.
    Template Description: Enter a brief description of the parameter template.
    3. On the displayed parameter configuration page, make sure that all parameter values are correct and the parameter template is created successfully.

    Default Template

    This page displays the default templates applicable to Redis 2.8 standard architecture, Redis 4.0 standard architecture, Redis 4.0 cluster architecture, Redis 5.0 standard architecture, and Redis 5.0 cluster architecture.
    Notes
    On the Default Template page, you can click View Details to view a template, but on the displayed details page, you cannot do any operation.

    Applying a Parameter Template to Instances

    During instance use

    Applying a parameter template to one or more instances

    1. Log in to the TencentDB for Redis console and select Parameter Template on the left sidebar.
    2. In the parameter template list, locate the desired template, and click Apply to Instance in the Operation column. Or, click View Details, enter the template details page, and click Apply to Instance.
    3. On the displayed page, specify the execution mode and instances, make sure that all parameter values are correct, and click Submit.
    Redis Instance: Select one or more instances that need to apply the parameter template in the specified region.
    Parameter Comparison: View the changed parameter values of the selected instance.
    Notes
    Before applying a parameter template to multiple instances, make sure that the instances do support those parameters.

    Importing a parameter template into the current instance

    1. Log in to the TencentDB for Redis console.
    2. Click the instance ID on the instance list page to enter the instance management page.
    3. On the instance management page, select the Parameter Settings tab.
    4. On the Modifiable Parameters tab, click Import from Template.
    5. In the Import from Parameter Template window, select a created parameter template in the drop-down list after Select Parameter Template.
    6. Click Import and Overwrite Original Parameters, and all parameters of the current instance will be configured according to the parameter values in the template.

    During instance purchase

    On the instance purchase page, select a default or custom parameter template for the new instances.
    Click the selection box next to Parameter Template and a drop-down list with a search box will pop up. The list shows the names and IDs of all existing parameter templates.
    Enter the parameter template name or ID in the search box to search for a template.

    

    Copying a Parameter Template

    To include most of the custom parameters and values of an existing parameter template in a new template, you can copy the existing template and modify it.

    Option 1

    1. Log in to the TencentDB for Redis console.
    2. Select Parameter Templates on the left sidebar, click the parameter template name or View Details in the Operation column in the template list, and enter the parameter template details page.
    3. Click Save as Template.
    4. In the pop-up window, configure the following parameters:
    Template Name: Enter a unique template name.
    Template Description: Enter a brief description of the parameter template.
    5. After confirming that everything is correct, click Save.

    Option 2

    1. Log in to the TencentDB for Redis console, select Instance List on the left sidebar, click an instance ID, and enter the instance management page.
    2. On the Parameter Settings tab, click Save as Template.
    3. In the pop-up window, configure the following parameters:
    Template Name: Enter a unique template name.
    Template Description: Enter a brief description of the parameter template.
    4. After confirming that everything is correct, click Create and Save.

    Modifying Parameter Values in a Parameter Template

    1. Log in to the TencentDB for Redis console, select Parameter Templates on the left sidebar, click the parameter template name or View Details in the Operation column in the template list, and enter the parameter template details page.
    2. Click Batch Modify Parameters or
    
    in the Current Value column to modify parameter values.
    Notes
    Default templates do not support the Batch Modify Parameters feature, and the Current Value column cannot be modified.

    Deleting a Parameter Template

    If a parameter template is created redundantly or no longer needed, it can be easily deleted.
    1. Log in to the TencentDB for Redis console and select Parameter Template on the left sidebar.
    2. In the parameter template list, locate the target template and click Delete in the Operation column.
    3. Click OK in the pop-up window.

    Related APIs

    API
    Description
    Applies a parameter template.
    Creates a parameter template.
    Deletes a parameter template.
    Queries the list of parameter modifications.
    Queries the list of parameter templates.
    Modifies instance parameters.
    Modifies a parameter template.
    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support