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

查询指定集群的巡检结果信息

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

我的收藏

1. 接口描述

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

查询指定集群的巡检结果信息

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

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

2. 输入参数

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

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

示例值:["cls-dsfef"]
Hide.N Array of String 隐藏的字段信息,为了减少无效的字段返回,隐藏字段不会在返回值中返回。可选值:results

示例值:["results"]
Name String 指定查询结果的报告名称,默认查询最新的每个集群只查询最新的一条
示例值:default-123456

3. 输出参数

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

4. 示例

示例1 获取集群巡检诊断结果示例1

获取集群巡检诊断结果,不隐藏结果

输入示例

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

{
    "ClusterIds": [
        "cls-dsff"
    ],
    "Hide": [
        ""
    ],
    "Name": "default-123456"
}

输出示例

{
    "Response": {
        "InspectionResults": [
            {
                "ClusterId": "cls-dsff",
                "Diagnostics": [
                    {
                        "Catalogues": [
                            {},
                            {}
                        ],
                        "Desc": "check master capacity",
                        "EndTime": "2022-11-11 06:41:23 +0000 UTC",
                        "Name": "master-capacity-update",
                        "Results": [
                            {
                                "Desc": "Master Capacity Check",
                                "Level": "failed",
                                "ObjInfo": [
                                    {}
                                ],
                                "ObjName": "pod-dsafasf",
                                "Proposal": "",
                                "Title": "Master Capacity Check"
                            }
                        ],
                        "StartTime": "2022-11-11 06:41:23 +0000 UTC",
                        "Statistics": [],
                        "Type": "master-capacity"
                    }
                ],
                "EndTime": "2022-11-11 06:31:23 +0000 UTC",
                "StartTime": "2022-11-11 06:41:23 +0000 UTC",
                "Statistics": [
                    {},
                    {},
                    {},
                    {}
                ]
            }
        ],
        "RequestId": "kubejarvis-test-case1"
    }
}

示例2 获取集群巡检诊断结果示例2

获取集群巡检诊断结果,隐藏结果

输入示例

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

{
    "ClusterIds": [
        "cls-dsff"
    ],
    "Hide": [
        "results"
    ],
    "Name": "default-123456"
}

输出示例

{
    "Response": {
        "InspectionResults": [
            {
                "ClusterId": "cls-dsff",
                "Diagnostics": [
                    {
                        "Catalogues": [
                            {},
                            {}
                        ],
                        "Desc": "check master capacity",
                        "EndTime": "2022-11-11 06:41:23 +0000 UTC",
                        "Name": "master-capacity-update",
                        "Results": null,
                        "StartTime": "2022-11-11 06:41:23 +0000 UTC",
                        "Statistics": [],
                        "Type": "master-capacity"
                    }
                ],
                "EndTime": "2022-11-11 06:31:23 +0000 UTC",
                "StartTime": "2022-11-11 06:41:23 +0000 UTC",
                "Statistics": [
                    {},
                    {},
                    {},
                    {}
                ]
            }
        ],
        "RequestId": "kubejarvis-test-case2"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ComponentClientUnpack 内部HTTP解包失败。
FailedOperation.KubernetesClientBuildError Kubernetes client建立失败。
FailedOperation.KubernetesListOperationError 获取Kubernetes资源列表失败。
InvalidParameter.Param 参数错误。