tencent cloud

Tencent Cloud Distributed Cache (Redis OSS-Compatible)

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
Terms of Service
Glossary
Contact Us

API Category

PDF
Focus Mode
Font Size
Last updated: 2025-10-24 14:47:30

Instance APIs

API Name Feature Frequency Limit (maximum requests per second)
AddReplicationInstance Adds replication group members 20
AllocateWanAddress Enables public network API 20
ChangeInstanceRole Modifies the role of an instance in a replication group 20
ChangeMasterInstance Switches with master instance in a replication group 20
CleanUpInstance Eliminates instance in recycle bin immediately 20
ClearInstance Clears Redis instance 20
CloseSSL Disables SSL 20
CreateInstanceAccount Customizes an instance account 20
CreateReplicationGroup Creates a replication group 20
DeleteInstanceAccount Deletes instance sub-account 20
DeleteReplicationInstance Deletes replication group members 20
DescribeAutoBackupConfig Gets automatic backup configuration 20
DescribeBandwidthRange Queries the information of instance bandwidth 20
DescribeInstanceAccount Views instance account information 20
DescribeInstanceDTSInfo Queries the DTS task details of instance 20
DescribeInstanceZoneInfo Queries Redis node details 20
DescribeInstances Queries the list of Redis instances 35
DescribeProxySlowLog Queries the slow queries of proxy 20
DescribeSlowLog Queries the slow log 20
DescribeTendisSlowLog Queries the slow queries of Tendis instance 20
DestroyPostpaidInstance Terminates pay-as-you-go instance 20
DestroyPrepaidInstance Returns monthly subscribed instance 20
DisableReplicaReadonly Disables read/write separation 20
EnableReplicaReadonly Enables read/write separation 20
InquiryPriceCreateInstance Queries the price for purchasing an instance 20
InquiryPriceUpgradeInstance Queries the price for scaling an instance 20
KillMasterGroup Performs failure simulation 20
ModifyAutoBackupConfig Configures automatic backup 20
ModifyInstance Modifies instance information 50
ModifyInstanceAccount Modifies an instance account 20
ModifyInstanceReadOnly Sets instance input mode 20
ModifyMaintenanceWindow Modifies instance maintenance time 20
ModifyNetworkConfig Modifies the network configuration of instance 20
OpenSSL Enables SSL 20
ReleaseWanAddress Disables public network API 20
RenewInstance Renews instance 20
ResetPassword Resets password 20
StartupInstance Deisolates instance 20
SwitchProxy Simulates the failure of a proxy node 20
UpgradeInstanceVersion Upgrades the instance architecture 20
UpgradeProxyVersion Upgrades instance proxy version 20
UpgradeSmallVersion Upgrades instance minor version 20
UpgradeVersionToMultiAvailabilityZones Upgrades instance to support multi-AZ deployment 20
DescribeCommonDBInstances Queries the list of Redis instance information (disused) 20
ChangeReplicaToMaster Promotes a replica node group to master node group 20
CloneInstances Clones an instance 20
CreateInstances Creates Redis instance 20
DescribeInstanceDealDetail Queries order information 20
DescribeInstanceNodeInfo Queries instance node information 20
DescribeInstanceShards Gets the information of Cluster Edition instance shards 20
DescribeMaintenanceWindow Queries instance maintenance window 20
DescribeParamTemplateInfo Queries parameter template details 20
DescribeReplicationGroup Queries the global replication group 20
DescribeSSLStatus Queries SSL status 20
DescribeTaskInfo Queries Redis task result 20
DescribeTaskList Queries the list of tasks 100
ModfiyInstancePassword Changes the instance access password 20
ModifyInstancePassword Changes the Redis password 20
RemoveReplicationInstance Removes a member from a replication group 20
UpgradeInstance Modifies the instance configuration 20
DescribeInstanceEvents Queries instance event information 50
DescribeReplicationGroupInstance Queries replication group information 20
ModifyInstanceAvailabilityZones Modifies the availability zone of the instance 20
ModifyInstanceEvent Modifies the operations event execution schedule of an instance 20
ModifyReplicationGroup Modifies replication group information 20
SwitchAccessNewInstance Switches operation immediately 20
DescribeInstanceSupportFeature Queries the supported features of the instance 20
DescribeSecondLevelBackupInfo Queries the second-level backup information on an instance 20
ModifyInstanceBackupMode Enables or disables the data flashback feature 20

Parameter Management APIs

API Name Feature Frequency Limit (maximum requests per second)
ApplyParamsTemplate Applies parameter template 20
CreateParamTemplate Creates parameter template 20
DeleteParamTemplate Deletes parameter template 20
DescribeInstanceParamRecords Queries the list of parameter modifications 20
DescribeInstanceParams Queries the list of instance parameters 20
DescribeInstanceSecurityGroup Queries the security group information of instance 20
DescribeParamTemplates Queries the list of parameter templates 20
DescribeProjectSecurityGroup Queries the security group information of project 20
ModifyConnectionConfig Modifies the number of connections and bandwidth of an instance 20
ModifyInstanceParams Modifies instance parameters 20
ModifyParamTemplate Modifies parameter template 20

Other APIs

API Name Feature Frequency Limit (maximum requests per second)
AssociateSecurityGroups Binds security group 20
DescribeDBSecurityGroups Queries security group details 100
DescribeProjectSecurityGroups Queries the security group details of project 20
DescribeRedisClusterOverview Queries the overview information of a dedicated Redis cluster 20
DescribeRedisClusters Queries the list of dedicated Redis clusters 20
DisassociateSecurityGroups Unbinds security group from instances in batches 20
ModifyDBInstanceSecurityGroups Modifies security groups bound to instance 20
RemoveReplicationGroup Deletes a replication group 20
SwitchInstanceVip Swaps the VIPs of instances 20
DescribeInstanceSpecBandwidth Queries or calculates bandwidth specifications 20

Backup and Restoration APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeBackupDetail Queries backup information details 20
DescribeBackupDownloadRestriction Queries the restrictions for downloading a backup file 20
DescribeBackupUrl Queries the download address of backup RDB 20
DescribeInstanceBackups Queries the list of Redis instance backups 50
ManualBackupInstance Manually backs up Redis instance 20
ModifyBackupDownloadRestriction Modifies the restrictions for downloading a backup file 20
RestoreInstance Restores Redis instance 20

Region APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeProductInfo Queries the purchasable product specifications 20
DescribeGlobalReplicationArea Queries the supported regions for global replication 20

Monitoring and Management APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeInstanceMonitorBigKey Queries the instance big key (disused) 20
DescribeInstanceMonitorBigKeySizeDist Queries the big key size distribution of an instance (disused) 20
DescribeInstanceMonitorBigKeyTypeDist Queries the big key type distribution of an instance (disused) 20
DescribeInstanceMonitorHotKey Queries instance hot keys 20
DescribeInstanceMonitorSIP Queries the access source information of an instance 20
DescribeInstanceMonitorTookDist Queries the distribution of instance access time 20
DescribeInstanceMonitorTopNCmd Queries an instance access command 20
DescribeInstanceMonitorTopNCmdTook Queries the instance CPU time 20

Log APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeInstanceLogDelivery Queries the instance log shipping configuration 20
ModifyInstanceLogDelivery Modifies the instance log shipping configuration 20

Help and Support

Was this page helpful?

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

Feedback