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

查询集群列表V2版本

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

1. 接口描述

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

查询集群列表

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

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

2. 输入参数

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

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

集团账号的成员id


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

通用过滤条件列表。支持的过滤字段:
ClusterId:集群ID,精确匹配。
ClusterName:集群名称,模糊匹配。
ClusterType:集群类型,精确匹配。取值:TKE_MANAGED_CLUSTER(腾讯云标准集群)、TKE_INDEPENDENT_CLUSTER(标准集群Master自维护)、TKE_SERVERLESS_CLUSTER(Serverless集群)、TKE_EDGE_CLUSTER(边缘集群)、SELF_BUILT(腾讯云内自建)、SELF_BUILT_OTHER(非腾讯云自建/混合云)。
RunStatus:集群运行状态,精确匹配。取值:Running(运行中)、Exception(异常)、Unknown(未知)。
AccessedStatus:接入状态,精确匹配。取值:AccessedNone(未接入)、AccessedInstalling(接入中)、AccessedException(接入异常)、AccessedInstalled(已接入)。
DefendStatus:防护状态,精确匹配。取值:Enabled(已防护)、Partial(部分防护)、Disabled(未防护)。
RiskStatus:风险检查状态,精确匹配。
RiskLevel:风险等级,精确匹配。取值:CRITICAL、HIGH、MEDIUM、LOW、NONE(无风险)。
HasHighRisk:仅筛选含高危及以上风险的集群,无需填入 value,传入 HasHighRisk 即生效。
Region:地域,精确匹配。
OwnerName:负责人,模糊匹配。
ClusterAssetIds:集群资产ID,精确匹配。
ExcludeClusterAssetIds:排除的集群资产ID,精确排除。

3. 输出参数

参数名称 类型 描述
TotalCount Integer

总数


示例值:10
List Array of ClusterListItem

列表

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

4. 示例

示例1 调用示例

输入示例

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

{}

输出示例

{
    "Response": {
        "List": [
            {
                "AlarmEventCriticalCount": 0,
                "AlarmEventHighCount": 0,
                "AlarmEventLowCount": 0,
                "AlarmEventMiddleCount": 0,
                "AppID": 260083796,
                "AssetId": "86693c5bf9e9fbdce993d557b1038fd8",
                "AuditLogSwitchStatus": 0,
                "ClusterId": "cls-pde9e0s0",
                "ClusterName": "yancyw-标准集群",
                "ClusterType": "TKE_MANAGED_CLUSTER",
                "DefendCoresCount": 0,
                "DefendStatus": "AccessedInstalled",
                "FailMessage": "资产同步失败",
                "LastAssetSyncTime": "2026-03-18T07:31:26Z",
                "LastRiskCheckTime": "2026-03-18T08:20:20Z",
                "NodeCount": 0,
                "OfflineNodeCount": 0,
                "OwnerName": "",
                "Region": "ap-guangzhou",
                "RiskEventCriticalCount": 0,
                "RiskEventHighCount": 0,
                "RiskEventLowCount": 0,
                "RiskEventMiddleCount": 0,
                "RiskStatus": "failed",
                "RunStatus": "Running",
                "Tags": [],
                "TotalCoresCount": 0,
                "UninstallNodeCount": 0,
                "Version": "1.30.0"
            }
        ],
        "TotalCount": 5,
        "RequestId": "cb1451b7-b9b9-4521-8097-e4c391b48ad7"
    }
}

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