1. 接口描述
接口请求域名: mongodb.tencentcloudapi.com 。
本接口(DescribeAuditLogs)用于查询数据库审计日志。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeAuditLogs。 |
| Version | 是 | String | 公共参数,本接口取值:2019-07-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID,格式如:cmgo-xftsghuy,与云数据库控制台页面中显示的实例 ID 相同。 示例值:cmgo-7pje**** |
| StartTime | 是 | String | 开始时间,格式为:"2017-07-12 10:29:20"。 示例值:2022-09-28 14:25:38 |
| EndTime | 是 | String | 结束时间,格式为:"2017-07-12 10:29:20"。 示例值:2022-09-28 15:25:38 |
| Filter | 否 | AuditLogFilter | 过滤条件,可按设置的过滤条件过滤日志。 |
| Limit | 否 | Integer | 分页参数,指单次返回的数据条数。默认值为100,最大值为100。 示例值:10 |
| Offset | 否 | Integer | 分页偏移量。 示例值:10 |
| Order | 否 | String | 审计日志的排序方式。
示例值:ASC |
| OrderBy | 否 | String | 审计日志的排序字段,包括:
示例值:timestamp |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合条件的审计日志条数。 示例值:1 |
| Items | Array of AuditLog | 审计日志详情。 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询审计日志
输入示例
POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAuditLogs
<公共请求参数>
{
"InstanceId": "cmgo-f0vo457l",
"StartTime": "2022-09-28 14:25:38",
"EndTime": "2026-09-28 15:25:38",
"Filter": {
"Atype": [
"insert"
],
"Result": [
"0"
],
"Param": [
"insert"
]
}
}
输出示例
{
"Response": {
"Items": [
{
"AffectRows": 2,
"Atype": "insert",
"ExecTime": 0,
"Host": "10.0.xx.xx",
"Param": "{ ns: dbinsert_2.collinsert_1, cmd: { _id: ObjectId('1'), df: [ \"sw\", \"re\" ], likes: 100, title: 3 } }",
"Result": 0,
"Roles": "xxx@admin",
"Timestamp": "2026-01-27 10:54:17",
"User": "mongouser@xxx"
}
],
"TotalCount": 2,
"RequestId": "184c371f-8635-4af9-881b-d0f29856c0f7"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.AuditCreateLogFileError | 创建审计日志文件错误。 |
| InternalError.AuditDeleteLogFileError | 删除审计日志错误。 |
| InternalError.AuditDescribeLogError | 查询审计日志错误。 |
| InternalError.AuditError | 审计内部服务错误。 |
| InternalError.AuditModifyStatusError | 修改审计状态失败。 |
| InternalError.CheckAppIdFailed | appId校验失败。 |
| InternalError.DBError | 数据库异常。 |
| InternalError.DBOperationError | 数据库操作失败。 |
| InternalError.DatabaseAccessError | 数据库内部错误。 |
| InternalError.InnerCommonError | 内部服务错误。 |
| InternalError.JSONError | json解析失败。 |
| InternalError.JsonUnmarshalError | Json反序列化错误。 |
| InternalError.TradeError | 交易系统错误。 |
| InvalidParameter.InvalidParameterError | 参数无效。 |
| InvalidParameterValue.DataConvertError | 数据转换失败 |
| OperationDenied.AuditPolicyConflictError | 审计策略冲突。 |
| OperationDenied.AuditPolicyExistError | 审计策略已存在。 |
| OperationDenied.AuditPolicyNotExistError | 审计策略不存在。 |
| OperationDenied.AuditPolicyOverQuotaError | 审计策略数量超限。 |
| OperationDenied.AuditStatusError | 审计状态异常。 |
| OperationDenied.AuditTaskConflictError | 审计任务冲突。 |
| OperationDenied.ResourceNotFundError | 资源未找到。 |
| OperationDenied.UnsupportOpenAuditError | 不支持开通审计。 |