帮你快速理解、总结文档立即下载

查询集群节点列表

最近更新时间:2026-08-20 01:44:00
我的收藏

1. 接口描述

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

查询集群节点列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeClusterNodeList。
Version String 公共参数,本接口取值:2022-11-21。
Region String 公共参数,此参数为可选参数。
MemberId.N Array of String

集团账号的成员id


示例值:["mem-a6df317cb6a8c424"]
Filter Filter

通用过滤条件列表。支持的过滤字段:
NodeName:节点名称,模糊匹配。
NodeId:节点ID,精确匹配。
NodeUniqueID:节点唯一ID,精确匹配(NodeAssetID 为等价别名)。
NodeType:节点类型,精确匹配。取值:SUPER(超级节点)、MASTER(主节点)、WORKER(工作节点)。
RunStatus:节点运行状态,精确匹配。
InternalIP:内网IP,精确匹配。
ClientStatus:客户端状态,精确匹配。取值:ONLINE(在线)、OFFLINE(离线)、UNINSTALL(未安装)。

ClusterCaMD5 String

集群ca证书md5值,集群的唯一标识


示例值:7e2e0b300aa27d0c2186a9c200debab5

3. 输出参数

参数名称 类型 描述
TotalCount Integer

总数


示例值:10
List Array of ClusterNodeListItem

列表

RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询集群节点列表

输入示例

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

{
    "MemberId": [
        "mem-tencent-6f5795752f66e429"
    ],
    "ClusterCaMD5": "83d4abefaac754bfaf66cc6342421eb9"
}

输出示例

{
    "Response": {
        "List": [
            {
                "AppID": 260083796,
                "AssetId": "",
                "ClientStatus": "OFFLINE",
                "CoresCount": 2000,
                "InstanceId": "ins-ngi794so",
                "InternalIP": "172.16.1.38",
                "NodeId": "ins-ngi794so",
                "NodeName": "as-tke-np-c63zg3iq",
                "NodeType": "WORKER",
                "PublicIP": "",
                "RunStatus": "Error",
                "Tags": [],
                "UniqueID": "de115e930d4f8c31a4c8a0a45b1bf88b"
            }
        ],
        "TotalCount": 7,
        "RequestId": "88da4e12-da90-4493-b540-3b22575bb806"
    }
}

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 参数错误。