API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > TDSQL-C MySQL 版 > 审计相关接口 > 查询数据库审计日志

查询数据库审计日志

最近更新时间：2024-04-03 11:16:02

我的收藏

本页目录：

1. 接口描述

接口请求域名： cynosdb.tencentcloudapi.com 。

本接口(DescribeAuditLogs)用于查询数据库审计日志。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeAuditLogs。
Version 是 String 公共参数，本接口取值：2019-01-07。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String 实例ID
示例值：cynosdbmysql-ins-xx
StartTime 是 String 开始时间，格式为："2017-07-12 10:29:20"。
示例值：2017-07-12 10:29:20
EndTime 是 String 结束时间，格式为："2017-07-12 10:29:20"。
示例值：2017-07-12 10:29:20
Order 否 String 排序方式。支持值包括："ASC" - 升序，"DESC" - 降序。
示例值：ASC
OrderBy 否 String 排序字段。支持值包括：
"timestamp" - 时间戳；
"affectRows" - 影响行数；
"execTime" - 执行时间。
示例值：timestap
Filter 否 AuditLogFilter 已废弃。
Limit 否 Integer 分页参数，单次返回的数据条数。默认值为100，最大值为100。
示例值：1
Offset 否 Integer 分页偏移量。
示例值：0
LogFilter.N 否 Array of InstanceAuditLogFilter 过滤条件。多个值之前是且的关系。

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合条件的审计日志条数。
示例值：1
Items Array of AuditLog 审计日志详情。
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询审计日志

查询审计日志

输入示例

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

{
    "InstanceId": "cynosdbmysql-ins-qwerasdf",
    "StartTime": "2017-07-12 10:29:20",
    "EndTime": "2017-07-13 10:29:20"
}

输出示例

{
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "TotalCount": "1",
        "Items": [
            {
                "PolicyName": "sys_default",
                "ExecTime": 0,
                "Timestamp": "2023-06-26 10:32:36.000",
                "AffectRows": 0,
                "ThreadId": 0,
                "TableName": "",
                "ErrCode": 0,
                "Host": "10.0.0.1",
                "SentRows": 0,
                "User": "test",
                "Sql": "SELECT * FROM test LIMIT 1;",
                "SqlType": "SELECT",
                "InstanceName": "test",
                "DBName": "test_db"
            }
        ]
    }
}

示例2 查询xx时间范围内，sql中包含selec或者upda，并且来源IP包含10.0.的记录

sql样例：select * from test_db limit 1;
sql INC selec 能搜索到;
sql WINC selec 搜索不到样例;

输入示例

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

{
    "InstanceId": "cynosdbmysql-ins-qwerasdf",
    "StartTime": "2023-08-01 00:00:00",
    "EndTime": "2023-08-07 00:00:00",
    "Limit": 20,
    "LogFilter": [
        {
            "Type": "sql",
            "Compare": "INC",
            "Value": [
                "selec",
                "up"
            ]
        },
        {
            "Type": "host",
            "Compare": "INC",
            "Value": [
                "10.0."
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "Items": null,
        "RequestId": "90d90456-2a5b-4015-81b8-9e2fca52012b",
        "TotalCount": 0
    }
}

示例3 查询xx时间范围内，sql中包含select和test_db，并且来源IP不等于10.0.0.1并且不等100.0.0.1的记录

输入示例

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

{
    "InstanceId": "cynosdbmysql-ins-qwerasdf",
    "StartTime": "2023-08-01 00:00:00",
    "EndTime": "2023-08-07 00:00:00",
    "Limit": 20,
    "LogFilter": [
        {
            "Type": "sql",
            "Compare": "WINC",
            "Value": [
                "select"
            ]
        },
        {
            "Type": "sql",
            "Compare": "WINC",
            "Value": [
                "test_db"
            ]
        },
        {
            "Type": "host",
            "Compare": "NEQ",
            "Value": [
                "10.0.0.1",
                "100.0.0.1"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "Items": null,
        "RequestId": "90d90456-2a5b-4015-81b8-9e2fca52012b",
        "TotalCount": 0
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter.ExceptionParam 参数传参错误。
InvalidParameter.InvalidParameterError 未知参数，请检查参数是否有效。
InvalidParameterValue.InvalidParameterValueError 参数值无效。
中国站