获取诊断事件详情

最近更新时间:2024-03-12 19:50:55

我的收藏

1. 接口描述

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

获取实例异常诊断事件的详情信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDBDiagEvent。
Version String 公共参数,本接口取值:2019-10-16。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID 。
示例值:test
EventId Integer 事件 ID 。通过“获取实例诊断历史DescribeDBDiagHistory”获取。
示例值:5
Product String 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL,默认为"mysql"。
示例值:mysql

3. 输出参数

参数名称 类型 描述
DiagItem String 诊断项。
示例值:健康巡检
DiagType String 诊断类型。
示例值:数据库快照
EventId Integer 事件 ID 。
示例值:5
Explanation String 事件详情。
示例值:[]
Outline String 概要。
示例值:数据库健康检查,发现1个问题
Problem String 诊断出的问题。
示例值:[{"DataType":"title","Data":{"Name":"会话快照"}},{"DataType":"title","Data":{"Name":"事务快照"}},{"DataType":"title","Data":{"Name":"Innodb状态快照"}}]
Severity Integer 严重程度。严重程度分为5级,按影响程度从高至低分别为:1:致命,2:严重,3:告警,4:提示,5:健康。
示例值:4
StartTime Timestamp 开始时间
示例值:2019-11-06 12:05:40
Suggestions String 建议。
示例值:[]
Metric String 保留字段。
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
EndTime Timestamp 结束时间。
示例值:2019-11-06 12:05:50
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取诊断事件详情

获取诊断事件详情。

输入示例

https://dbbrain.tencentcloudapi.com/?Action=DescribeDBDiagEvent
&InstanceId=test
&EventId=5
&<公共请求参数>

输出示例

{
    "Response": {
        "Suggestions": "[]",
        "DiagType": "数据库快照",
        "EndTime": "2019-11-06 12:05:50",
        "RequestId": "78cf7bb1-0608-11ea-a9ef-2736f0f7f829",
        "Explanation": "[]",
        "StartTime": "2019-11-06 12:05:40",
        "Severity": 4,
        "EventId": 5,
        "Outline": "数据库健康检查,发现1个问题",
        "Problem": "[{\"DataType\":\"title\",\"Data\":{\"Name\":\"会话快照\"}},{\"DataType\":\"title\",\"Data\":{\"Name\":\"事务快照\"}},{\"DataType\":\"title\",\"Data\":{\"Name\":\"Innodb状态快照\"}}]",
        "Metric": "",
        "DiagItem": "健康巡检"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
OperationDenied.UserHasNoStrategy CAM鉴权错误。
UnauthorizedOperation 未授权操作。