云数据库独享集群查询 DB Custom 集群列表

1. 接口描述

接口请求域名： dbdc.tencentcloudapi.com 。

该接口（DescribeDBCustomClusters）为DB Custom 集群列表查询接口。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDBCustomClusters。
Version	是	String	公共参数，本接口取值：2020-10-29。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-nanjing, ap-shanghai 。
ClusterIds.N	否	Array of String	按照一个或者多个 ClusterId 查询。入参限制：每次请求的数量上限为100 示例值：["dbcc-0cj0av3j"]
Filters.N	否	Array of Filter	查询筛选条件。支持的筛选条件包括： cluster-name：DB Custom 集群名称，精确匹配。 cluster-status：DB Custom 集群状态（Creating，Running，Destroying）。
Tags.N	否	Array of Tag	根据标签的 Key 和 Value 筛选 DB Custom 集群
Offset	否	Integer	集群列表分页偏移量示例值：0
Limit	否	Integer	返回数量取值范围：[1, 100] 默认值：20 示例值：10

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	总集群数量示例值：1
ClusterSet	Array of DBCustomCluster	集群列表信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询 DB Cluster 集群列表

按标签筛选

输入示例

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

{
    "Tags": [
        {
            "Key": "DBCustomCluster",
            "Value": "PRE-CLUSTER"
        }
    ],
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "Response": {
        "ClusterSet": [
            {
                "ClusterDescription": "",
                "ClusterId": "dbcc-nmtmsew8",
                "ClusterLevel": "L500",
                "ClusterName": "DBCustomPRE",
                "ClusterNodeNum": 0,
                "ClusterStatus": "Running",
                "ClusterVersion": "1.32.2",
                "CreatedTime": "2026-06-06T11:05:40Z",
                "Region": "ap-shanghai",
                "Tags": [
                    {
                        "Key": "DBCustomCluster",
                        "Value": "PRE-CLUSTER"
                    }
                ]
            }
        ],
        "TotalCount": 1,
        "RequestId": "b5156a5a-122f-4d42-8322-06237ee54131"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation	请求未授权。请参考 CAM 文档对鉴权的说明。
FailedOperation	操作失败。
InvalidParameterValue	参数取值错误。

查询 DB Custom 集群列表

本页目录：