云数据库 MongoDB 查询审计服务配置

1. 接口描述

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

本接口(DescribeAuditConfig)用于查询云数据库审计策略的服务配置，包括审计日志保存时长等。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAuditConfig。
Version	是	String	公共参数，本接口取值：2019-07-25。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例 ID，格式如：cmgo-xftsghuy，与云数据库控制台页面中显示的实例 ID 相同。示例值：cmgo-c1nl****

3. 输出参数

参数名称	类型	描述
InstanceId	String	实例id 注意：此字段可能返回 null，表示取不到有效值。示例值：cmgo-c1nl****
InstanceName	String	实例名称注意：此字段可能返回 null，表示取不到有效值。示例值：cmgo-c1nl****
AuditAll	Boolean	true表示全审计，false表示规则审计注意：此字段可能返回 null，表示取不到有效值。示例值：true
CreateTime	String	该实例开通数据库审计的时间。示例值：2021-11-30 16:19:46
LogExpireDay	Integer	审计日志保存时长。单位：天。目前支持的保存时长包括：0、30、180、365，1095、1825。注意：此字段可能返回 null，表示取不到有效值。示例值：30
LogType	String	审计日志存储类型。目前仅支持storage：存储型。示例值：storage
IsClosing	String	是否正在关闭审计功能。 true：是。 false：否。示例值：false
IsOpening	String	是否正在开启审计功能。 true：是。 false：否。示例值：false
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询审计服务配置

输入示例

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

{
    "InstanceId": "cmgo-bfyv0sy7"
}

输出示例

{
    "Response": {
        "AuditAll": true,
        "CreateTime": "2025-12-11 11:47:20",
        "InstanceId": "cmgo-bfyv****",
        "InstanceName": "cmgo-bfyv****",
        "IsClosing": "false",
        "IsOpening": "false",
        "LogExpireDay": 7,
        "LogType": "storage",
        "RequestId": "d94bc81b-3b76-4104-9270-0582d8227ebc"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InternalError.AuditDescribeLogError	查询审计日志错误。
InternalError.CosError	获取文件信息失败。
InternalError.DBError	数据库异常。
InternalError.DBOperationError	数据库操作失败。
InternalError.InnerCommonError	内部服务错误。
InternalError.JSONError	json解析失败。
InternalError.JsonUnmarshalError	Json反序列化错误。
InternalError.TradeError	交易系统错误。
OperationDenied.AuditPolicyConflictError	审计策略冲突。
OperationDenied.AuditPolicyExistError	审计策略已存在。
OperationDenied.AuditPolicyNotExistError	审计策略不存在。
OperationDenied.AuditPolicyOverQuotaError	审计策略数量超限。
OperationDenied.AuditTaskConflictError	审计任务冲突。
OperationDenied.ResourceNotFundError	资源未找到。

查询审计服务配置

本页目录：