查询智能运维诊断结果报告

最近更新时间:2024-03-12 01:30:25

我的收藏

1. 接口描述

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

查询智能运维诊断结果报告

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDiagnose。
Version String 公共参数,本接口取值:2018-04-16。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String ES实例ID
示例值:es-abcdefgh
Date String 报告日期,格式20210301
示例值:20210301
Limit Integer 报告返回份数
示例值:1

3. 输出参数

参数名称 类型 描述
Total Integer 诊断报告个数
示例值:10
DiagnoseResults Array of DiagnoseResult 诊断报告列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询智能运维诊断结果报告

查询智能运维诊断结果报告

输入示例

https://es.tencentcloudapi.com/?Action=DescribeDiagnose
&InstanceId=es-xxxxxxxx
&<公共请求参数>

输出示例

{
    "Response": {
        "Total": 0,
        "DiagnoseResults": [
            {
                "JobResults": [
                    {
                        "Status": 0,
                        "MetricDetails": [
                            {
                                "Metrics": [
                                    {
                                        "Dimensions": [
                                            {
                                                "Value": "1",
                                                "Key": "1"
                                            }
                                        ],
                                        "Value": 0.0
                                    }
                                ],
                                "Key": "1"
                            }
                        ],
                        "Detail": "1",
                        "Summary": "1",
                        "SettingDetails": [
                            {
                                "Advise": "1",
                                "Value": "1",
                                "Key": "1"
                            }
                        ],
                        "Score": 0,
                        "Advise": "1",
                        "JobName": "1",
                        "LogDetails": [
                            {
                                "Count": 0,
                                "Advise": "1",
                                "Key": "1"
                            }
                        ]
                    }
                ],
                "InstanceId": "1",
                "Completed": true,
                "Score": 0,
                "RequestId": "1",
                "JobParam": {
                    "Indices": "1",
                    "Interval": 1,
                    "Jobs": [
                        "1"
                    ]
                },
                "CreateTime": "1",
                "JobType": 0
            }
        ],
        "RequestId": "1"
    }
}

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.InvalidAppId AppId的取值和预期不符。
InvalidParameter.InvalidInstanceId 无效的InstanceId,没有找到对应资源。
InvalidParameter.InvalidRegion 地域Region的取值与预期不符。
InvalidParameter.InvalidTimeParam 时间相关参数的取值或格式和预期不符。
ResourceNotFound.DBInfoNotFound 数据库资源获取失败。
ResourceNotFound.DiagnoseNotFound 智能诊断相关资源未找到。
UnsupportedOperation.DiagnoseNotOpen 智能诊断未开启。