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
Database Audit
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

Node.JS Connection Sample

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-03-17 17:45:56

Prerequisites

Run the npm install hiredis redis command to install node-redis.
Note:
Note: Please use the latest version of npm. For details, see npm official documentation.

Example Code

const { createClient } = require('redis');

/** Fill in the following parameters with your Redis instance's private IP address, port number, instance ID, and password */
const host = "192.xx.xx.2";
const port = "6379";
const instanceid = "c53xx52f-55dc-4c22-a941-630xxx88";
const pwd = "12as6zb";

// Create a Redis client (new version API)
const client = createClient({
// Use URL format with authentication information
url: `redis://${encodeURIComponent(instanceid)}:${encodeURIComponent(pwd)}@${host}:${port}`,
// or use separate parameters (choose either one)
/*
socket: {
host: host,
port: parseInt(port) // Underwrite the port is a number
},
username: instanceid, // Redis 6.0+ ACL username
password: pwd,
*/
// other configuration
pingInterval: 60000, // Keep the connection active
disableOfflineQueue: true // Disable command caching when offline
});

// Redis connection error handling (event name unchanged in new version)
client.on('error', (err) => {
console.error('Redis connection error:', err);
});

// Connect to Redis and execute operations
(async () => {
try {
// Explicitly establish a connection (new version requirement)
await client.connect();
console.log('Redis connected successfully');

/** Start operating the Redis instance */
// Set a Key (new version API)
const setResult = await client.set("redis", "tencent");
console.log(`set key redis ${setResult}, value is tencent`);
// Get Key (new version API)
const value = await client.get("redis");
console.log(`get key redis is: ${value}`);
} catch (err) {
console.error('Redis operation error:', err);
} finally {
// Close client when program ends (new version uses quit or disconnect)
await client.quit(); // or client.disconnect()
console.log('Redis connection closed');
}
})();

Execution Result

Note:
Note: If an exception occurred during connection, please refer to Private Network Unable to Connect Location Guide to fix it.
Redis connected successfully
set key redis OK, value is tencent
get key redis is: tencent
Redis connection closed

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백