API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 容器安全服务 > 集群安全相关接口 > 查询单个集群的详细信息

查询单个集群的详细信息

最近更新时间：2024-03-12 01:51:24

我的收藏

本页目录：

1. 接口描述

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

查询单个集群的详细信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeClusterDetail。
Version 是 String 公共参数，本接口取值：2020-11-01。
Region 否 String 公共参数，此参数为可选参数。
ClusterId 是 String 集群id
示例值：cls-jvrv0kf2

3. 输出参数

参数名称 类型 描述
ClusterId String 集群id
示例值：cls-jvrv0kf2
ClusterName String 集群名字
示例值：tke_test
ScanTaskProgress Integer 当前集群扫描任务的进度，100表示扫描完成.
示例值：20
ClusterVersion String 集群版本
示例值：1.8.8
ContainerRuntime String 运行时组件
示例值：docker
ClusterNodeNum Integer 集群节点数
示例值：2
ClusterStatus String 集群状态 (Running 运行中 Creating 创建中 Abnormal 异常 )
示例值：Running
ClusterType String 集群类型：为托管集群MANAGED_CLUSTER、独立集群INDEPENDENT_CLUSTER
示例值：MANAGED_CLUSTER
Region String 集群区域
示例值：ap-guangzhou
SeriousRiskCount Integer 严重风险检查项的数量
示例值：3
HighRiskCount Integer 高风险检查项的数量
示例值：2
MiddleRiskCount Integer 中风险检查项的数量
示例值：4
HintRiskCount Integer 提示风险检查项的数量
示例值：5
CheckStatus String 检查任务的状态
DefenderStatus String 防御容器状态
TaskCreateTime String 扫描任务创建时间
示例值：2021-10-19 12:26:56
NetworkType String 网络类型.PublicNetwork为公网类型,VPCNetwork为VPC网络
示例值：PublicNetwork
ApiServerAddress String API Server地址
示例值：https://10.100.0.123:60002
NodeCount Integer 节点数
示例值：4
NamespaceCount Integer 命名空间数
示例值：4
WorkloadCount Integer 工作负载数
示例值：4
PodCount Integer Pod数量
示例值：5
ServiceCount Integer Service数量
示例值：5
IngressCount Integer Ingress数量
示例值：5
MasterIps String 主节点的ip列表
示例值：127.0.0.1;127.0.0.2;
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询集群详情

查询集群的详细信息

输入示例

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

{
    "ClusterId": "b6ebf065d08563396da66bf0950cba8c"
}

输出示例

{
    "Response": {
        "RequestId": "6c4a3216-1849-48d1-b02c-bb83801044b6",
        "ClusterId": "b6ebf065d08563396da66bf0950cba8c",
        "ClusterName": "wk-usercluster-test",
        "ScanTaskProgress": 0,
        "ClusterVersion": "v1.20.6-tke.12",
        "ContainerRuntime": "docker://19.3.9",
        "ClusterNodeNum": 4,
        "ClusterStatus": "Running",
        "DefenderStatus": "Defender_Normal",
        "ClusterType": "Kubernetes",
        "Region": "ap-guangzhou",
        "SeriousRiskCount": 0,
        "HighRiskCount": 0,
        "MiddleRiskCount": 0,
        "HintRiskCount": 0,
        "CheckStatus": "Task_Running",
        "TaskCreateTime": "2022-05-06 11:03:19",
        "NetworkType": "PublicNetwork",
        "ApiServerAddress": "https://xxxx:60002",
        "NodeCount": 4,
        "NamespaceCount": 0,
        "WorkloadCount": 0,
        "PodCount": 0,
        "ServiceCount": 0,
        "IngressCount": 0,
        "MasterIps": "127.0.0.1;127.0.0.2;"
    }
}

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签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
OperationDenied 操作被拒绝。
RequestLimitExceeded 请求的次数超过了频率限制。
UnauthorizedOperation 未授权操作。
中国站