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

查询集群概览数据

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

1. 接口描述

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

查询集群概览数据

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

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

2. 输入参数

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

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

集团账号的成员id


示例值:["mem-6wfo0fzks3","mem-85fo0fzks4"]

3. 输出参数

参数名称 类型 描述
TotalClusterCount Integer

集群总数


示例值:10
TotalNodeCount Integer

节点总数


示例值:40
TotalCoreCount Integer

总核数


示例值:100
UsedCoreQuota Integer

已使用核数额度


示例值:0
PurchasedCoreQuota Integer

已购买核数额度


示例值:0
ElasticCoreQuota Integer

弹性计费核数


示例值:0
UnprotectedCoreCount Integer

集群未防护核数


示例值:0
ProtectedCoreCount Integer

集群已防护核数


示例值:0
UnprotectedClusterCount Integer

未防护集群数


示例值:0
ProtectedClusterCount Integer

已防护集群数


示例值:0
TkeClusterCount Integer

腾讯云TKE集群数量


示例值:6
SelfBuiltClusterCount Integer

自建集群数量


示例值:1
UnboundUltimateNodeCount Integer

未绑定旗舰版节点数量


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

4. 示例

示例1 集群概览

输入示例

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

{}

输出示例

{
    "Response": {
        "AlarmClusterCount": 0,
        "AlarmEventCount": 0,
        "CriticalAlarmClusterCount": 0,
        "CriticalAlarmEventCount": 0,
        "CriticalRiskClusterCount": 0,
        "CriticalRiskEventCount": 44,
        "ElasticCoreQuota": 0,
        "HighAlarmClusterCount": 0,
        "HighAlarmEventCount": 0,
        "HighRiskClusterCount": 0,
        "HighRiskEventCount": 47,
        "LowAlarmEventCount": 0,
        "LowRiskEventCount": 0,
        "MiddleAlarmEventCount": 0,
        "MiddleRiskEventCount": 0,
        "ProtectedClusterCount": 0,
        "ProtectedCoreCount": 0,
        "PurchasedCoreQuota": 0,
        "RiskClusterCount": 0,
        "RiskEventCount": 91,
        "SelfBuiltClusterCount": 2,
        "TkeClusterCount": 6,
        "TotalClusterCount": 8,
        "TotalCoreCount": 0,
        "TotalNodeCount": 15,
        "UnprotectedClusterCount": 0,
        "UnprotectedCoreCount": 0,
        "UsedCoreQuota": 0,
        "RequestId": "6c8827c8-d279-482e-be86-457f160e655d"
    }
}

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