有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

获取指定时间段内的诊断事件列表,支持依据风险等级、实例ID等条件过滤。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDBDiagEvents。
Version String 公共参数,本接口取值:2021-05-27。
Region String 公共参数,详见产品支持的 地域列表
StartTime Timestamp ISO8601 开始时间,如“2021-05-27 00:00:00”,支持的最早查询时间为当前时间的前30天。
示例值:2021-05-27 00:00:00
EndTime Timestamp ISO8601 结束时间,如“2021-05-27 01:00:00”,结束时间与开始时间的间隔最大可为7天。
示例值:2021-05-27 01:00:00
Severities.N Array of Integer 风险等级列表,取值按影响程度从高至低分别为:1 - 致命、2 -严重、3 - 告警、4 - 提示、5 -健康。
示例值:[1, 2, 3, 4]
InstanceIds.N Array of String 实例ID列表。
示例值:["cdb-test"]
Offset Integer 偏移量,默认0。
示例值:0
Limit Integer 返回数量,默认20,最大值为50。
示例值:20

3. 输出参数

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

4. 示例

示例1 获取诊断事件列表

输入示例

https://dbbrain.tencentcloudapi.com/?Action=DescribeDBDiagEvents
&StartTime=2021-05-27T00:00:00+00:00
&EndTime=2021-05-27T01:00:00+00:00
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "7a9a6ba0-5893-11ec-8ad2-ff04c623cbd9",
        "TotalCount": 1,
        "Items": [
            {
                "InstanceId": "cdb-test",
                "EventId": 330858512,
                "StartTime": "2021-05-27 00:01:10",
                "EndTime": "2021-05-27 00:01:20",
                "DiagItem": "事务未提交",
                "DiagType": "事务未提交",
                "Severity": 1,
                "Outline": "存在未提交事务",
                "Metric": "",
                "Region": "ap-guangzhou"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.UserHasNoStrategy CAM鉴权错误。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。