tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeRedisClusters

Last updated: 2024-12-04 11:20:00

1. API Description

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

This API is used to query the list of dedicated Redis clusters.

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: DescribeRedisClusters.
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.
RedisClusterIds.N No Array of String Dedicated Redis cluster ID. Log in to the CDC console,
switch to the Cloud Service Management page, select TencentDB for Redis from the drop-down list, and obtain the dedicated cluster ID.
Status.N No Array of Integer Cluster status.
- 1: in process.
- 2: running.
- 3: isolated.
ProjectIds.N No Array of Integer Project ID array. Log in to the project management page and copy the project ID in Project Name.
AutoRenewFlag.N No Array of Integer Renewal mode.
- 0: default status (manual renewal).
- 1: automatic renewal.
- 2: no automatic renewal.
ClusterName No String Dedicated Redis cluster name.
SearchKey No String Search keyword. Valid values: cluster ID and cluster name.
Limit No Integer Limit on the number of records returned in pagination mode. If this parameter is not specified, the value 20 will be used by default.
Offset No Integer Offset, which is an integer multiple of Limit.
DedicatedClusterId No String CDC ID. Log in to the CDC console
and obtain the cluster ID in the instance list.

3. Output Parameters

Parameter Name Type Description
Total Integer Total number of clusters.
Resources Array of CDCResource CDC cluster resource list.
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 Example 1

Input Example

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

{
    "Limit": "100",
    "DedicatedClusterId": "cluster-0astoh6a",
    "Offset": "0"
}

Output Example

{
    "Response": {
        "Total": 4,
        "Resources": [
            {
                "AppId": 251200288,
                "RegionId": 1,
                "ZoneId": 100002,
                "PayMode": 1,
                "ProjectId": 0,
                "AutoRenewFlag": 0,
                "ClusterName": "crs-cdc-9nyfki8h",
                "StartTime": "2022-06-10 14:40:33",
                "EndTime": "2022-07-10 14:40:33",
                "Status": 1,
                "RedisClusterId": "crs-cdc-9nyfki8h",
                "BaseBundles": [
                    {
                        "ResourceBundleName": "cc-standard",
                        "AvailableMemory": 0,
                        "Count": 1
                    }
                ],
                "ResourceBundles": [
                    {
                        "ResourceBundleName": "resource-bundle-mini",
                        "AvailableMemory": 16,
                        "Count": 1
                    }
                ],
                "DedicatedClusterId": "cluster-0astoh6a"
            },
            {
                "AppId": 251200288,
                "RegionId": 1,
                "ZoneId": 100002,
                "PayMode": 1,
                "ProjectId": 0,
                "AutoRenewFlag": 0,
                "ClusterName": "crs-cdc-3blwadqr",
                "StartTime": "2022-06-10 11:43:57",
                "EndTime": "2022-07-10 11:43:57",
                "Status": 1,
                "RedisClusterId": "crs-cdc-3blwadqr",
                "BaseBundles": [
                    {
                        "ResourceBundleName": "cc-standard",
                        "AvailableMemory": 0,
                        "Count": 1
                    }
                ],
                "ResourceBundles": [
                    {
                        "ResourceBundleName": "resource-bundle-mini",
                        "AvailableMemory": 16,
                        "Count": 1
                    }
                ],
                "DedicatedClusterId": "cluster-0astoh6a"
            },
            {
                "AppId": 251200288,
                "RegionId": 1,
                "ZoneId": 100002,
                "PayMode": 1,
                "ProjectId": 0,
                "AutoRenewFlag": 0,
                "ClusterName": "crs-cdc-etfesut3",
                "StartTime": "2022-06-10 11:00:25",
                "EndTime": "2022-07-10 11:00:25",
                "Status": 1,
                "RedisClusterId": "crs-cdc-etfesut3",
                "BaseBundles": [
                    {
                        "ResourceBundleName": "cc-standard",
                        "AvailableMemory": 0,
                        "Count": 1
                    }
                ],
                "ResourceBundles": [
                    {
                        "ResourceBundleName": "resource-bundle-mini",
                        "AvailableMemory": 16,
                        "Count": 1
                    },
                    {
                        "ResourceBundleName": "resource-bundle-large",
                        "AvailableMemory": 538,
                        "Count": 1
                    }
                ],
                "DedicatedClusterId": "cluster-0astoh6a"
            },
            {
                "AppId": 251200288,
                "RegionId": 1,
                "ZoneId": 100002,
                "PayMode": 1,
                "ProjectId": 0,
                "AutoRenewFlag": 0,
                "ClusterName": "crs-cdc-4myknrdf",
                "StartTime": "2022-06-10 10:33:12",
                "EndTime": "2022-08-10 10:33:12",
                "Status": 2,
                "RedisClusterId": "crs-cdc-4myknrdf",
                "BaseBundles": [
                    {
                        "ResourceBundleName": "cc-standard",
                        "AvailableMemory": 0,
                        "Count": 1
                    }
                ],
                "ResourceBundles": [
                    {
                        "ResourceBundleName": "resource-bundle-mini",
                        "AvailableMemory": 16,
                        "Count": 1
                    },
                    {
                        "ResourceBundleName": "resource-bundle-small-1",
                        "AvailableMemory": 48,
                        "Count": 2
                    }
                ],
                "DedicatedClusterId": "cluster-0astoh6a"
            }
        ],
        "RequestId": "1504cdf3-0095-4694-86d2-5f2a6f8c99a4"
    }
}

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
InternalError Internal error.
InvalidParameter Incorrect parameter.
ResourceNotFound The resource doesn’t exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy