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

DescribeProductInfo

PDF
Focus Mode
Font Size
Last updated: 2025-10-28 22:21:32

1. API Description

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

This API is used to query purchasable TencentDB for Redis specifications in all regions.

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: DescribeProductInfo.
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.

3. Output Parameters

Parameter Name Type Description
RegionSet Array of RegionConf Selling information on the region. The selling information on all regions is returned even if a region is specified.
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 Request Example

Example

Input Example

POST / HTTP/1.1
Host: redis.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProductInfo
<Common request parameters>

{}

Output Example

{
    "Response": {
        "RegionSet": [
            {
                "RegionId": "ap-guangzhou",
                "RegionName": "Guangzhou",
                "RegionShortName": "GZ",
                "Area": "South China",
                "ZoneSet": [
                    {
                        "ZoneId": "ap-guangzhou-2",
                        "ZoneName": "Guangzhou Zone 2",
                        "IsSaleout": false,
                        "IsDefault": false,
                        "OldZoneId": 0,
                        "NetWorkType": [
                            "basenet",
                            "vpcnet"
                        ],
                        "ProductSet": [
                            {
                                "Type": 7,
                                "TypeName": "Redis Cluster Edition",
                                "MinBuyNum": 1,
                                "MaxBuyNum": 10,
                                "Saleout": false,
                                "Engine": "Redis Community Edition",
                                "Version": "Redis 4.0",
                                "TotalSize": [
                                    "12",
                                    "20",
                                    "32",
                                    "64",
                                    "96",
                                    "128",
                                    "256",
                                    "384",
                                    "512",
                                    "768",
                                    "1024",
                                    "2048",
                                    "3072",
                                    "4096"
                                ],
                                "ShardSize": [
                                    "4",
                                    "8",
                                    "12",
                                    "16",
                                    "20",
                                    "24",
                                    "32"
                                ],
                                "ReplicaNum": [
                                    "1",
                                    "2",
                                    "3",
                                    "4",
                                    "5"
                                ],
                                "ShardNum": [
                                    "3",
                                    "5",
                                    "8",
                                    "12",
                                    "16",
                                    "24",
                                    "32",
                                    "40",
                                    "48",
                                    "64",
                                    "80",
                                    "96",
                                    "128"
                                ],
                                "PayMode": "1",
                                "EnableRepicaReadOnly": true
                            },
                            {
                                "Type": 4,
                                "TypeName": "CKV Cluster Edition",
                                "MinBuyNum": 1,
                                "MaxBuyNum": 10,
                                "Saleout": false,
                                "Engine": "Tencent Cloud CKV",
                                "Version": "Redis 3.2",
                                "TotalSize": [
                                    "12",
                                    "20",
                                    "32",
                                    "64",
                                    "96",
                                    "128",
                                    "256",
                                    "384",
                                    "512",
                                    "768",
                                    "1024",
                                    "2048",
                                    "3072",
                                    "4096"
                                ],
                                "ShardSize": [
                                    "4",
                                    "8",
                                    "16",
                                    "24",
                                    "32",
                                    "48",
                                    "64",
                                    "80",
                                    "96",
                                    "128",
                                    "160",
                                    "192",
                                    "256",
                                    "320",
                                    "384"
                                ],
                                "ReplicaNum": [
                                    "1",
                                    "2",
                                    "3",
                                    "4",
                                    "5"
                                ],
                                "ShardNum": [
                                    "3",
                                    "5",
                                    "8",
                                    "12",
                                    "16",
                                    "24",
                                    "32",
                                    "40",
                                    "48",
                                    "64",
                                    "80",
                                    "96",
                                    "128"
                                ],
                                "PayMode": "1",
                                "EnableRepicaReadOnly": false
                            },
                            {
                                "Type": 2,
                                "TypeName": "Redis Primary-Secondary Edition",
                                "MinBuyNum": 1,
                                "MaxBuyNum": 10,
                                "Saleout": false,
                                "Engine": "Redis Community Edition",
                                "Version": "Redis 2.8",
                                "TotalSize": [
                                    "1",
                                    "2",
                                    "4",
                                    "8",
                                    "12",
                                    "16",
                                    "20",
                                    "24",
                                    "32",
                                    "40",
                                    "48",
                                    "60",
                                    "0.25"
                                ],
                                "ShardSize": [
                                    "1",
                                    "2",
                                    "4",
                                    "8",
                                    "12",
                                    "16",
                                    "20",
                                    "24",
                                    "32",
                                    "40",
                                    "48",
                                    "60",
                                    "0.25"
                                ],
                                "ReplicaNum": [
                                    "1"
                                ],
                                "ShardNum": [
                                    "1"
                                ],
                                "PayMode": "1",
                                "EnableRepicaReadOnly": false
                            },
                            {
                                "Type": 5,
                                "TypeName": "Redis Single-node Edition",
                                "MinBuyNum": 1,
                                "MaxBuyNum": 10,
                                "Saleout": false,
                                "Engine": "Redis Community Edition",
                                "Version": "Redis 2.8",
                                "TotalSize": [
                                    "1",
                                    "2",
                                    "4",
                                    "8",
                                    "12",
                                    "16",
                                    "20",
                                    "24",
                                    "32",
                                    "40",
                                    "48",
                                    "60"
                                ],
                                "ShardSize": [
                                    "1",
                                    "2",
                                    "4",
                                    "8",
                                    "12",
                                    "16",
                                    "20",
                                    "24",
                                    "32",
                                    "40",
                                    "48",
                                    "60"
                                ],
                                "ReplicaNum": [
                                    "0"
                                ],
                                "ShardNum": [
                                    "1"
                                ],
                                "PayMode": "1",
                                "EnableRepicaReadOnly": false
                            },
                            {
                                "Type": 2,
                                "TypeName": "Redis Primary-Secondary Edition",
                                "MinBuyNum": 1,
                                "MaxBuyNum": 10,
                                "Saleout": false,
                                "Engine": "Redis Community Edition",
                                "Version": "Redis 2.8",
                                "TotalSize": [
                                    "1",
                                    "2",
                                    "4",
                                    "8",
                                    "12",
                                    "16",
                                    "20",
                                    "24",
                                    "32",
                                    "40",
                                    "48",
                                    "60"
                                ],
                                "ShardSize": [
                                    "1",
                                    "2",
                                    "4",
                                    "8",
                                    "12",
                                    "16",
                                    "20",
                                    "24",
                                    "32",
                                    "40",
                                    "48",
                                    "60"
                                ],
                                "ReplicaNum": [
                                    "1"
                                ],
                                "ShardNum": [
                                    "1"
                                ],
                                "PayMode": "0",
                                "EnableRepicaReadOnly": false
                            },
                            {
                                "Type": 3,
                                "TypeName": "CKV Single-node Edition",
                                "MinBuyNum": 1,
                                "MaxBuyNum": 10,
                                "Saleout": false,
                                "Engine": "Tencent Cloud CKV",
                                "Version": "Redis 3.2",
                                "TotalSize": [
                                    "4",
                                    "8",
                                    "16",
                                    "24",
                                    "32",
                                    "48",
                                    "64",
                                    "80",
                                    "96",
                                    "128",
                                    "160",
                                    "192",
                                    "256",
                                    "320",
                                    "384"
                                ],
                                "ShardSize": [
                                    "4",
                                    "8",
                                    "16",
                                    "24",
                                    "32",
                                    "48",
                                    "64",
                                    "80",
                                    "96",
                                    "128",
                                    "160",
                                    "192",
                                    "256",
                                    "320",
                                    "384"
                                ],
                                "ReplicaNum": [
                                    "0"
                                ],
                                "ShardNum": [
                                    "1"
                                ],
                                "PayMode": "1",
                                "EnableRepicaReadOnly": false
                            }
                        ]
                    }
                ]
            }
        ],
        "RequestId": "3c5730c6-02f2-46fd-8bf1-725b8b608fb9"
    }
}

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

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.
InternalError.InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameter.EmptyParam The parameter is empty.
InvalidParameter.PermissionDenied The API has no CAM permissions.

Help and Support

Was this page helpful?

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

Feedback