文档中心>容器服务>API 文档>集群巡检相关接口>查询集群巡检结果概览信息

查询集群巡检结果概览信息

最近更新时间:2024-03-12 01:56:59

我的收藏

1. 接口描述

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

查询用户单个Region下的所有集群巡检结果概览信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeClusterInspectionResultsOverview。
Version String 公共参数,本接口取值:2018-05-25。
Region String 公共参数,详见产品支持的 地域列表
ClusterIds.N Array of String Array of String 目标集群列表,为空查询用户所有集群

示例值:["cls-abc", "cls-def"]
GroupBy.N Array of String 聚合字段信息,概览结果按照 GroupBy 信息聚合后返回,可选参数:
catalogue.first:按一级分类聚合
catalogue.second:按二级分类聚合
示例值:catalogue.second

3. 输出参数

参数名称 类型 描述
Statistics Array of KubeJarvisStateStatistic 诊断结果统计
注意:此字段可能返回 null,表示取不到有效值。
Diagnostics Array of KubeJarvisStateDiagnosticOverview 诊断结果概览
注意:此字段可能返回 null,表示取不到有效值。
InspectionOverview Array of KubeJarvisStateInspectionOverview 集群诊断结果概览
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询集群巡检报告概览

ClusterIds为空,默认查询所有集群

输入示例

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

{
    "ClusterIds": []
}

输出示例

{
    "Response": {
        "RequestId": "kubejarvis-test-case1",
        "Diagnostics": [
            {
                "Catalogues": [
                    {},
                    {}
                ],
                "Statistics": [
                    {},
                    {},
                    {},
                    {}
                ]
            },
            {
                "Catalogues": [
                    {},
                    {}
                ],
                "Statistics": []
            }
        ],
        "Statistics": [
            {},
            {},
            {},
            {}
        ],
        "InspectionOverview": [
            {
                "ClusterId": "cls-dsafas",
                "Statistics": [
                    {}
                ],
                "Diagnostics": [
                    {
                        "Catalogues": [
                            {},
                            {}
                        ]
                    }
                ]
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.KubernetesClientBuildError Kubernetes client建立失败。
FailedOperation.KubernetesListOperationError 获取Kubernetes资源列表失败。
InternalError.UnexpectedInternal 未知的内部错误。
InvalidParameter.Param 参数错误。
UnsupportedOperation 操作不支持。