Cache for Redis
Cache for Redis
Cache for Redis
Document
What's new
Product announcements
Overview
Billing
Quick start
User guide
Instance management
High availability
Multi-availability-zone disaster recovery solution
Modifying instance configuration
Tag management
Network connection management
Connecting to instance
Account and access authorization
Data security
Monitoring and alerts
Backup and recovery
Backup
Parameter management
Parameter template management
Event management
Performance analysis
Best practices
Data migration and synchronization
Development reference (Control plane)
API reference
Region and availability zone
Instance management
Modifying instance configuration
Billing management
Backup and recovery
Parameter management
Connection management
Account management
Allowlist management
Log management
Performance analysis
Failure drills
SDK reference
Terraform reference
Development reference (Data plane)
Supported commands
Redis open-source command support
FAQ
Errors and exceptions
- Documentation
Cache for RedisUser guideParameter managementParameter template managementCreating parameter template
Copy page
Download PDFParameter template management
Creating parameter template
Copy pageDownload PDFCreating parameter template
Cache for Redis provides the parameter template function. When you need to configure one or more Redis instances with the same parameter values for the same database version, you can use the parameter template feature to centralize the management of parameters and quickly apply the parameters in the template to the target instance to improve the efficiency of parameter management and instance configuration. This topic describes how to create parameter template.
Precautions
Each primary account of Volcano Engine can create up to 20 custom parameter templates in each region by default.
Procedure
- Log in to the Redis console.
- In the upper-left corner of the top menu bar, select the project and region to which the instance belongs.
- In the left-side navigation pane, select NoSQL Database > Redis > Parameter templates.
- On Customized templates tab, click Create parameter template.
- In Create parameter template panel, set the following parameters.
- ParametersRequired?DescriptionTemplate nameYesEnter the name of the parameter template. The name needs to meet the following requirements simultaneously:
- It cannot start with a number or hyphen (-).
- It can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-).
- The length should be 2 to 64 characters.
Database versionYesSelect the Redis database version to which the parameter template is adapted from the drop-down list. You can choose Redis 7.0, Redis 6.0, Redis 5.0, or Redis 4.0.Template descriptionNoEnter the remarks for the parameter template whose length cannot exceed 200 characters.Template parametersYesYou can perform the following operations in the Template parameters area:- Add single parameter
- Select the parameter name to be set from the Parameter name drop-down box.
- Set the parameter value in the input box under Parameter value.
- If you need to add more parameters to the template, click Add parameters just below the list, and then repeat the above operation steps to complete the addition of a single parameter.
- Batch add parameters
- Click Add parameters in batches at the lower left corner of the parameter list.
- In the pop-up dialog box, enter the parameter names and parameter values to be added to the template.
- Enter in the format of ParameterName=value, and please break lines between multiple sets of data.
- Example is as follows.
- active-defrag-cycle-max=20active-defrag-cycle-min=10
- Delete added parameters
- Click Delete in the Actions column on the right side of the added parameter to remove the parameter from the parameter template.
tip- Each parameter template must contain at least one parameter.
- For details of the parameters supported by each database version and the value range of the parameters, refer to Supported parameters.
- Click OK.
Subsequent operations
After the parameter template is created, you can apply the parameter template to the target instance. For specific procedures, refer to Applying parameter template.
Relevant APIs
API | Description |
Call the CreateParameterGroup API to create a parameter template. | |
Call the DescribeParameterGroups API to query the basic information of parameter templates under the current account and region. | |
Call the DescribeParameterGroupDetail API to query the detailed information of the target parameter group. |
Last updated: 2025.12.15 20:52:05
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
