1. 接口描述
接口请求域名： cdb.tencentcloudapi.com 。
在不同过滤条件下的审计日志结果集中，选定特定的数据列进行聚合统计。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：AnalyzeAuditLogs。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID。 示例值：cdb-r9bpb9gs |
| StartTime | 是 | String | 要分析的日志开始时间，格式为："2023-02-16 00:00:20"。 示例值：2023-02-16 00:00:20 |
| EndTime | 是 | String | 要分析的日志结束时间，格式为："2023-02-16 00:10:20"。 示例值：2023-02-16 00:10:20 |
| AggregationConditions.N | 是 | Array of AggregationCondition | 聚合维度的排序条件。 |
| AuditLogFilter | 否 | AuditLogFilter | 已废弃。该过滤条件下的审计日志结果集作为分析日志。 |
| LogFilter.N | 否 | Array of InstanceAuditLogFilters | 该过滤条件下的审计日志结果集作为分析日志。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Items | Array of AuditLogAggregationResult | 返回的聚合桶信息集 注意：此字段可能返回 null，表示取不到有效值。 |
| TotalCount | Integer | 扫描的日志条数 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 审计日志聚合统计
审计日志聚合统计
输入示例
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AnalyzeAuditLogs
<公共请求参数>
{
"InstanceId": "cdb-r9bpb9gs",
"StartTime": "2023-02-16 00:00:20",
"EndTime": "2023-02-16 00:10:20",
"AggregationConditions": [
{
"AggregationField": "host",
"Offset": 0,
"Limit": 3
},
{
"AggregationField": "sqlType",
"Offset": 3,
"Limit": 3
}
]
}输出示例
{
"Response": {
"Items": [
{
"AggregationField": "host",
"Buckets": [
{
"Count": 89,
"Key": "100.122.76.176"
},
{
"Count": 10,
"Key": "9.71.156.179"
},
{
"Count": 1,
"Key": "10.0.6.6"
}
]
},
{
"AggregationField": "sqlType",
"Buckets": [
{
"Count": 13,
"Key": "LOGOUT"
},
{
"Count": 5,
"Key": "CREATE"
},
{
"Count": 2,
"Key": "INSERT"
}
]
}
],
"RequestId": "0000000000000-00000-014",
"TotalCount": 100
}
}示例2 先过滤后聚合审计日志
先过滤后聚合审计日志
输入示例
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AnalyzeAuditLogs
<公共请求参数>
{
"InstanceId": "cdb-r9bpb9gs",
"StartTime": "2023-02-16 00:00:00",
"EndTime": "2023-02-17 00:00:00",
"AuditLogFilter": {
"SqlTypes": [
"create"
]
},
"AggregationConditions": [
{
"AggregationField": "host",
"Offset": 0,
"Limit": 3
}
]
}输出示例
{
"Response": {
"Items": [
{
"AggregationField": "host",
"Buckets": [
{
"Count": 3,
"Key": "100.122.76.176"
},
{
"Count": 2,
"Key": "9.71.156.179"
}
]
}
],
"RequestId": "0000000000000-00000-015",
"TotalCount": 5
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.ControllerNotFoundError | 未找到该接口。 |
| InvalidParameter.ExceptionParam | 异常参数。 |
| InvalidParameter.InvalidParameterError | 无效的参数值。 |
| UnsupportedOperation | 操作不支持。 |
