1. 接口描述
接口请求域名： dbbrain.api3.fincloud.tencent.com。
获取实例异常诊断事件的详情信息。
默认接口请求频率限制：20次/秒。
接口更新时间：2025-05-16 14:29:11。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeDBDiagEvent |
| Version | 是 | 否 | String | 公共参数，本接口取值：2021-05-27 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Product | 是 | 否 | String | 服务产品类型，支持值包括： "mariadb" - 数据库 MariaDB， "dcdb" - 数据库 TDSQL MySQL，默认为"mariadb"。 示例值： dbbrain |
| InstanceId | 是 | 否 | String | 实例 ID 。 示例值： shard-lm6o3jwi |
| EventId | 是 | 否 | Int64 | 事件 ID 。通过“获取实例诊断历史DescribeDBDiagHistory”获取。 示例值： 5 |
| ClusterId | 否 | 是 | String | 集群 ID。 示例值： tdsqlshard-70m8bedq |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Explanation | String | 诊断事件详情，若无附加解释信息则输出为空。 示例值： [{"DataType":"title"}] |
| Outline | String | 诊断概要。 示例值： 数据库健康检查，发现1个问题 |
| Problem | String | 诊断出的问题。 示例值： [{"DataType":"title","Data":{"Name":"会话快照"}}] |
| DiagItem | String | 诊断项。 示例值： 健康巡检 |
| DiagType | String | 诊断类型。 示例值： 数据库快照 |
| StartTime | Datetime | 开始时间 示例值： 2019-11-06 12:05:40 |
| Suggestions | String | 诊断建议，若无建议则输出为空。 示例值： [{"DataType":"title","Data":{"Name":"SQL优化"}}] |
| Metric | String | 保留字段。 示例值： innodb_rows_read_per_qps |
| EndTime | Datetime | 结束时间。 示例值： 2019-11-06 12:05:50 |
| EventId | Int64 | 事件 ID 。 示例值： 5 |
| Severity | Int64 | 严重程度。严重程度分为5级，按影响程度从高至低分别为：1：致命，2：严重，3：告警，4：提示，5：健康。 示例值： 4 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | |
| InvalidParameter | |
| UnauthorizedOperation | |
| UnsupportedOperation | |
| MissingParameter | |
| AuthFailure | |
| InternalError | |
| LimitExceeded | |
| ResourceNotFound | |
| OperationDenied | |
| FailedOperation | |
| UnknownParameter | |
| OperationDenied.UserHasNoStrategy |