查询Redis独享集群列表

最近更新时间:2024-08-02 02:01:17

我的收藏

1. 接口描述

接口请求域名: redis.tencentcloudapi.com 。

查询Redis独享集群列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeRedisClusters。
Version String 公共参数,本接口取值:2018-04-12。
Region String 公共参数,详见产品支持的 地域列表
RedisClusterIds.N Array of String Redis独享集群id
示例值:['crs-cdc-p8ktf94h']
Status.N Array of Integer 集群状态:1-流程中,2-运行中,3-已隔离
示例值:[1,2]
ProjectIds.N Array of Integer 项目ID数组
示例值:[0]
AutoRenewFlag.N Array of Integer 续费模式:0 - 默认状态(手动续费);1 - 自动续费;2 - 明确不自动续费
示例值:[0,1,2]
ClusterName String Redis独享集群名称
示例值:测试集群1
SearchKey String 搜索关键词:支持集群Id、集群名称
示例值:crs-cdc-p8ktf94h
Limit Integer 分页限制返回大小,不传则默认为20
示例值:10
Offset Integer 偏移量,取Limit整数倍
示例值:0
DedicatedClusterId String 本地专用集群id
示例值:cluster-0astoh6a

3. 输出参数

参数名称 类型 描述
Total Integer 集群总数
示例值:10
Resources Array of CDCResource CDC集群资源列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例1

输入示例

POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRedisClusters
<公共请求参数>

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

输出示例

{
    "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. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
ResourceNotFound 资源不存在。