tencent cloud

数据库智能管家 DBbrain

获取数据库审计日志

下载
聚焦模式
字号
最后更新时间: 2026-10-15 15:40:17

1. 接口描述

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

查询指定实例在时间窗口内的审计日志明细,支持按 SQL 类型、执行耗时、错误码、关键词等多条件过滤。当前仅支持 dcdb、mariadb 产品(cdb、cynosdb 已切至中台)。注意 Filter.MultiSql 与 Filter.ExcludeMultiSql 需以 JSON 字符串形式传递二维数组内容,例如 [["a","b"]] 表示 (a OR b),服务端会自动解析。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribeDBAuditLogs。
Version 是 String 公共参数,本接口取值:2021-05-27。
Region 是 String 公共参数,详见产品支持的 地域列表。
Product 是 String

服务产品类型。当前 云 API 仅支持:dcdb、mariadb(cdb、cynosdb 已切至中台)。

StartTime 是 String

开始时间,格式 yyyy-MM-dd HH:mm:ss。

EndTime 是 String

结束时间,格式 yyyy-MM-dd HH:mm:ss。

InstanceId 否 String

实例 ID,必填。dcdb、mariadb 场景以实例维度查询审计日志。

LogType 否 String

日志类型:Proxy 代理日志,DB 数据库日志,All 全部。

SortBy 否 String

排序字段,默认 Timestamp。

OrderBy 否 String

排序方式:ASC 升序,DESC 降序。默认 DESC。

Offset 否 Integer

偏移量,默认 0。

Limit 否 Integer

返回数量,默认 20,最大 100。

SqlStartTime 否 Integer

SQL 开始时间(毫秒级时间戳),根据 QueryId 关联查询时使用。

Filter 否 AuditLogQueryFilter

审计日志查询过滤条件集合。

ClusterId 否 String

集群 ID,dcdb 产品以集群维度查询审计日志

3. 输出参数

参数名称 类型 描述
TotalCount Integer

满足条件的总条数。

FilteredRecords Integer

过滤后记录数。

ProxyLogs Array of AuditProxyLogItem

Proxy 层审计日志列表。LogType=Proxy 或 All 时返回,字段结构参见 AuditProxyLogItem。

DBLogs Array of AuditDBLogItem

DB 层审计日志列表。LogType=DB 或 All 时返回,字段结构参见 AuditDBLogItem。

RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询 mariadb Proxy 审计日志

查询 mariadb 实例的 Proxy 审计日志示例。MultiSql 使用 JSON 字符串承载二维数组。

输入示例

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

{
    "Product": "mariadb",
    "InstanceId": "tdsql-1zsrqfdkh4",
    "LogType": "Proxy",
    "StartTime": "2026-10-10 11:05:06",
    "EndTime": "2026-10-10 12:05:06",
    "Limit": 20,
    "Offset": 0,
    "Filter": {
        "SqlType": [
            "SELECT",
            "INSERT"
        ],
        "ExecTime": [
            100,
            200
        ],
        "ErrCode": "0",
        "MultiSql": "[[\"a\",\"b\"]]",
        "DBName": [
            "da"
        ],
        "User": [
            "dfg"
        ],
        "Host": [
            "123.1.1.1"
        ],
        "ThreadId": [
            "12301"
        ]
    }
}

输出示例

{
    "Response": {
        "RequestId": "ed279d8b-a9d9-48d6-9429-e0fde000994a",
        "TotalCount": 1,
        "FilteredRecords": 0,
        "ProxyLogs": [
            {
                "Timestamp": "2026-10-10 18:19:39",
                "ClusterId": "tdsql-1zsrqfdkh4",
                "User": "shine",
                "Host": "11.161.84.21",
                "DBName": "",
                "Sql": "/*p=dmc,o=100047808302,i=121ea724*/ CREATE DATABASE `test` DEFAULT CHARACTER SET = utf8mb4 DEFAULT COLLATE = utf8mb4_0900_ai_ci;",
                "SqlType": "Create",
                "SqlTemplate": "Create",
                "SqlTemplateId": "2026540316",
                "ComType": "COM_QUERY",
                "ExecTime": 255,
                "SqlStartTime": 1791627579927,
                "SqlStartTimeUs": 927490,
                "ThreadId": "513208377",
                "ProxyHost": "30.122.175.73:24717",
                "ProxyThread": "57875",
                "Autocommit": "1",
                "HoldConns": "1",
                "NewConnNum": 0,
                "AffectRows": 0,
                "SentRows": 0,
                "ErrCode": "1044",
                "ErrInfo": "Access denied for user 'shine'@'%' to database 'test'",
                "BusinessCode": "i=121ea724,o=100047808302,p=dmc",
                "BusinessTag": ""
            }
        ]
    }
}

5. 开发者资源

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
DryRunOperation DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。
FailedOperation 操作失败。
FailedOperation.AuditNotOpened 实例审计未开启
FailedOperation.PaasAuditNotOpened paas 侧商业审计状态未开启
FailedOperation.SegmentLoading 数据加载中
InternalError 内部错误。
InternalError.DbOperationFailed 数据库操作失败
InternalError.InternalError InternalError.InternalError
InvalidFilter 无效的过滤器
InvalidParameter 参数错误。
InvalidParameter.InvalidParameter InvalidParameter.InvalidParameter
InvalidParameterCombination 无效参数组合
InvalidParameterValue 参数取值错误。
InvalidParameterValue.InvalidParameterValue InvalidParameterValue.InvalidParameterValue
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
MissingParameter.MissingParameter MissingParameter.MissingParameter
OperationDenied 操作被拒绝。
OperationDenied.UserHasNoStrategy CAM鉴权错误。
RegionError 地域错误
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceInUse 资源被占用。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
ResourcesSoldOut 资源售罄。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.UnauthorizedOperation UnauthorizedOperation.UnauthorizedOperation
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。
UnsupportedOperation.HasDuplicatedTask 该时间范围内的审计日志已下载

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈