1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
查询集群详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeClusterDetail。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-6wfo0fzks3","mem-85fo0fzks4"] |
| ClusterCaMD5 | 否 | String | 集群ca证书md5值,集群的唯一标识 示例值:657bf05114bf46d6cee11a68012b5740 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ClusterBaseInfo | ClusterListItem | 集群基础信息 |
| RuntimeComponent | String | 运行时组件 示例值:containerd |
| MasterIP | String | master ip 示例值:172.16.51.1 |
| NodeCount | Integer | 节点数 示例值:0 |
| NamespaceCount | Integer | 命名空间数 示例值:7 |
| PodCount | Integer | pod数 示例值:0 |
| ContainerCount | Integer | 容器数 示例值:0 |
| ServiceCount | Integer | service数 示例值:0 |
| IngressCount | Integer | ingress数 示例值:0 |
| ImageCount | Integer | 镜像数 示例值:0 |
| SystemComponentCount | Integer | 系统组件数量 示例值:10 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 调用示例
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterDetail
<公共请求参数>
{
"ClusterAssetId": "86693c5bf9e9fbdce993d557b1038fd8"
}
输出示例
{
"Response": {
"ClusterBaseInfo": {
"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"
},
"ContainerCount": 0,
"ImageCount": 0,
"IngressCount": 0,
"MasterIP": "",
"NamespaceCount": 7,
"NodeCount": 0,
"PodCount": 0,
"RuntimeComponent": "containerd",
"ServiceCount": 0,
"RequestId": "7da09158-1246-473d-852d-0b873a7b0900"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |