Release Notes and Announcements

Release Notes

Announcements

User Tutorial

Product Introduction

Overview

Product Strengths

Use Cases

Storage Engine

Product Series

Product Versions

Specifications and Performance

Read/Write Separation

Multi-AZ Deployment

Regions and AZs

Terms

Service Regions and Service Providers

Purchase Guide

Billing Overview

Pricing Center

Instance Purchasing

Renewal (Yearly/Monthly Subscription)

Refund (Yearly/Monthly Subscription)

Overdue Payments

Switching from Pay-as-You-Go to Yearly/Monthly Subscription

Getting Started

Quickly Creating an Instance

Connecting to Redis Instance

Operation Guide

Operation Overview

Connecting to a Database Instance

Managing Instances

Upgrade Instance

Management Node (Redis/ValKey Edition)

Multi-AZ Deployment Management

Backup and Restoration

Managing Accounts

Parameter Configuration

Slow Query

Access Management

Network and Security

Monitoring and Alarms

Event Management (Redis/ValKey Edition)

Data Migration

Global Replication for Redis Edition

Performance Optimization

Sentinel Mode

Development Guidelines

Naming Rules

Basic Usage Guidelines

Design Principles of Key and Value

Command Usage Guidelines

Design Principles of Client Programs

Connection Pool Configuration

Command Reference

Command Reference Overview

Redis Edition and Valkey Edition Command Compatibility

Version Command Usage Differences

Differences Between the Proxy Architecture and Direct Connection Mode

More Command Operations (Redis/Valkey Edition)

Memcached Edition Command Compatibility

Practical Tutorial

Building TencentDB for Redis® Client Monitoring Based on Spring Boot

Redis Client Connection Configuration Policy and Practice

Global SCAN Guide for Cluster Architecture

Eliminating Instances Securely

Hot Key and Big Key

AZ Migration Scheme

Troubleshooting

Connection Exception

Exception Analysis and Solution of Redisson Client Timeout Reconnection

Performance Troubleshooting and Fine-Tuning

API Documentation

History

Introduction

API Category

Making API Requests

Instance APIs

Parameter Management APIs

Other APIs

Backup and Restoration APIs

Region APIs

Monitoring and Management APIs

Log APIs

Data Types

Error Codes

FAQs

General

Connection and Login

Purchase

Service Agreement

Service Level Agreement

Glossary

ApplyParamsTemplate

PDF

Focus Mode

Font Size

Last updated: 2026-01-13 21:49:54

1. API Description

Domain name for API request: redis.intl.tencentcloudapi.com.

This API is used to apply parameter templates to instances.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ApplyParamsTemplate.
Version	Yes	String	Common Params. The value used for this API: 2018-04-12.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceIds.N	Yes	Array of String	Instance ID list. Log in to the Redis console and copy the instance ID in the instance list.
TemplateId	Yes	String	ID of the applied parameter template. - The parameter template ID can be obtained through the response parameter TemplateId of the API DescribeParamTemplateInfo. - The operation can only be successfully performed when the parameter template version matches the architecture version of the target instance. A version mismatch will trigger an execution error.

3. Output Parameters

Parameter Name	Type	Description
TaskIds	Array of Integer	Task ID
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Modifying instance parameters

Input Example

https://redis.intl.tencentcloudapi.com/?Action=ApplyParamsTemplate
&InstanceIds.0=crs-5a4py64p
&TemplateId=crs-cfg-rhlppeye
&<Common request parameters>

Output Example

{
    "Response": {
        "TaskIds": [
            212,
            213,
            214
        ],
        "RequestId": "e546784b-709c-401d-aba6-73037eb4e522"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.SystemError	Internal system error, which is irrelevant to the business.
FailedOperation.UnSupportError	The instance does not support this API.
InternalError.DbOperationFailed	Internal system error with the database operation, which may be update, insert, select, etc.
InternalError.InternalError	Internal error.
InvalidParameter	Incorrect parameter.
InvalidParameter.PermissionDenied	The API has no CAM permissions.
ResourceNotFound.InstanceNotExists	No Redis instance is found by the serialId.
ResourceUnavailable.CallOssError	Failed to call the backend API.
ResourceUnavailable.InstanceConfError	An instance configuration error occurred.
ResourceUnavailable.InstanceLockedError	Redis has been locked by another process.
ResourceUnavailable.InstanceStateError	Instance status error.
UnauthorizedOperation	The operation is unauthorized.
UnauthorizedOperation.NoCAMAuthed	No CAM permissions.
UnauthorizedOperation.UserNotInWhiteList	The user is not in the allowlist.

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Tencent Cloud Distributed Cache (Redis OSS-Compatible)