文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>API 中心>云数据库独享集群>DB Custom 相关接口>查询 DB Custom 节点列表

查询 DB Custom 节点列表

最近更新时间：2026-06-17 01:25:29

我的收藏

本页目录：

1. 接口描述

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

该接口（DescribeDBCustomNodes）用于查询 DB Custom 节点列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeDBCustomNodes。
Version 是 String 公共参数，本接口取值：2020-10-29。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-nanjing, ap-shanghai 。
NodeIds.N 否 Array of String

按照一个或者多个 NodeId 查询。

入参限制：每次请求的数量上限为100


示例值：["dbcn-wamuy21e"]
Filters.N 否 Array of Filter

查询筛选条件。支持的筛选条件包括：

  • cluster-id：按 DB Custom 集群进行过滤。
  • node-name：按 DB Custom 节点名称进行过滤，精确匹配。
  • status：按 DB Custom 节点状态进行过滤。（可选值：Creating，Running，Isolating，Isolated，Activating（解除隔离中），Destroying）
  • zone：按 DB Custom 节点所在可用区进行过滤。
Tags.N 否 Array of Tag

根据标签的 Key 和 Value 筛选 DB Custom 节点
Offset 否 Integer

分页偏移量


示例值：0
Limit 否 Integer

返回数量

取值范围：[1, 100]

默认值：20


示例值：10

3. 输出参数

参数名称 类型 描述
TotalCount Integer

当前账号下拥有的DB Custom 节点总数


示例值：1
NodeSet Array of DBCustomNode

当前账号下拥有的DB Custom 节点列表信息
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询 DB Custom 节点列表

输入示例

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

{
    "NodeIds": [
        "dbcn-wamuy21e"
    ],
    "Filters": [
        {
            "Name": "cluster-id",
            "Values": [
                "dbcc-jnfqi1b9"
            ]
        }
    ],
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "Response": {
        "NodeSet": [
            {
                "AutoRenew": 2,
                "CPU": 4,
                "ChargeType": "PREPAID",
                "ClusterId": "dbcc-jnfqi1b9",
                "CreatedTime": "2026-06-01T14:14:40Z",
                "DataDisks": [
                    {
                        "DiskName": "ImageDisk",
                        "DiskSize": 10,
                        "DiskType": "CLOUD_HSSD"
                    }
                ],
                "ExpireTime": "2026-08-01T14:14:40Z",
                "HostIp": "7E87DEECE245155C880A7CF5355CD81F",
                "ImageId": "img-1tmhysjj",
                "IsolatedTime": "",
                "LanIP": "10.0.0.1",
                "Memory": 8,
                "NodeId": "dbcn-wamuy21e",
                "NodeName": "测试节点",
                "NodeType": "DB.AT5.8XLARGE128",
                "OsName": "TencentOS Server 3.2 with Driver",
                "RackId": "3E5BA837F9B5FFD91DCC02DBF501C7A7",
                "SSHEndpoint": "10.0.0.100:36000",
                "Status": "Running",
                "SubnetId": "subnet-clk8il4i",
                "SwitchId": "3E7A16039D8E141849DE7C837DE70ECC",
                "SystemDisk": {
                    "DiskSize": 100,
                    "DiskType": "CLOUD_BSSD"
                },
                "Tags": [
                    {
                        "Key": "test-key1",
                        "Value": "test-key1-value"
                    }
                ],
                "VpcId": "vpc-evvog2gd",
                "Zone": "ap-shanghai-5"
            }
        ],
        "TotalCount": 1,
        "RequestId": "e8841f33-dc54-4c5f-a1d4-b940bc09e1df"
    }
}

示例2 查询 DB Custom 节点列表（按标签筛选）

输入示例

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

{
    "Tags": [
        {
            "Key": "产品",
            "Value": "DBCustom"
        }
    ],
    "Limit": 10
}

输出示例

{
    "Response": {
        "NodeSet": [
            {
                "AutoRenew": 2,
                "CPU": 2,
                "ChargeType": "PREPAID",
                "ClusterId": "",
                "CreatedTime": "2026-06-05T12:52:38Z",
                "DataDisks": [
                    {
                        "DiskName": "ImageDisk",
                        "DiskSize": 200,
                        "DiskType": "CLOUD_HSSD"
                    }
                ],
                "ExpireTime": "2026-07-05T12:52:38Z",
                "HostIp": "7E9DD09DDF2FFB1FFA0E7430F1DF9085",
                "ImageId": "img-1tmhysjj",
                "IsolatedTime": "",
                "LanIP": "172.16.64.16",
                "Memory": 2,
                "NodeId": "dbcn-7avvxiri",
                "NodeName": "DBCustomPRE2",
                "NodeType": "DB.AT5.8XLARGE128",
                "OsName": "TencentOS Server 3.2 with Driver",
                "RackId": "9BD3E57A3DBE1201ACC65A0D06749DB8",
                "SSHEndpoint": "172.16.64.12:22",
                "Status": "Running",
                "SubnetId": "subnet-huka6qhj",
                "SwitchId": "1708E3E3DB05DE76DBEF337046C07BAE",
                "SystemDisk": {
                    "DiskSize": 100,
                    "DiskType": "CLOUD_HSSD"
                },
                "Tags": [
                    {
                        "Key": "产品",
                        "Value": "DBCustom"
                    }
                ],
                "VpcId": "vpc-cseo7req",
                "Zone": "ap-shanghai-5"
            }
        ],
        "TotalCount": 2,
        "RequestId": "60214b3e-4b60-432f-851e-150c0465ed04"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

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