云数据库独享集群查询 DB Custom 集群详情

1. 接口描述

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

该接口(DescribeDBCustomClusterDetail) 用于查询 DB Custom 集群的详情信息。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDBCustomClusterDetail。
Version	是	String	公共参数，本接口取值：2020-10-29。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-nanjing, ap-shanghai 。
ClusterId	是	String	DB Custom 集群ID 入参限制：必须为此账号拥有的DB Custom集群示例值：dbcc-jnfqi1b9

3. 输出参数

参数名称	类型	描述
ClusterId	String	集群ID 示例值：dbcc-jnfqi1b9
ClusterName	String	集群名称示例值：测试 DB Custom 集群
ClusterDescription	String	集群描述示例值：该集群用于测试集群购买流程
Region	String	集群所属地域枚举值： ap-shanghai：上海地域 ap-nanjing：南京地域示例值：ap-shanghai
ClusterStatus	String	DB Custom 集群状态枚举值： Creating：创建中 Running：运行中 Destroying：销毁中示例值：Running
ClusterVersion	String	集群版本枚举值： 1.34.1：集群版本1.34.1 默认值：1.34.1 示例值：1.34.1
ClusterNodeNum	Integer	集群下的节点数量示例值：1
ClusterLevel	String	集群规模示例值：L5
CreatedTime	String	创建时间示例值：2026-06-01T15:08:04Z
Tags	Array of Tag	集群标签信息注意：此字段可能返回 null，表示取不到有效值。
ApiServerNetwork	ApiServerNetwork	集群的API Server的网络信息注意：此字段可能返回 null，表示取不到有效值。
ContainerNetwork	ContainerNetwork	容器网络，在此集群中的所有Pod将与此网络连通注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询 DB Custom 集群详情

输入示例

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

{
    "ClusterId": "dbcc-jnfqi1b9"
}

输出示例

{
    "Response": {
        "ApiServerNetwork": {
            "SubnetId": "subnet-clk8il4i",
            "VpcId": "vpc-evvog2gd"
        },
        "ClusterDescription": "该集群用于测试集群购买流程",
        "ClusterId": "dbcc-jnfqi1b9",
        "ClusterLevel": "L5",
        "ClusterName": "测试 DB Custom 集群",
        "ClusterNodeNum": 1,
        "ClusterStatus": "Running",
        "ClusterVersion": "1.34.1",
        "ContainerNetwork": {
            "SubnetIds": [
                "subnet-clk8il4i"
            ],
            "VpcId": "vpc-evvog2gd"
        },
        "CreatedTime": "2026-06-01T15:08:04Z",
        "Region": "ap-shanghai",
        "Tags": [
            {
                "Key": "测试集群TagKey",
                "Value": "测试集群TagValue"
            }
        ],
        "RequestId": "969a02eb-0755-4162-a7ba-a6947a3d5628"
    }
}

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 集群详情

本页目录：