操作指南

API 文档

查询审计服务配置

最近更新时间:2022-04-13 06:14:16

我的收藏

1. 接口描述

接口请求域名: cdb.tencentcloudapi.com 。

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAuditConfig。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID,格式如:cdb-c1nl9rpv 或者 cdbro-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。

3. 输出参数

参数名称 类型 描述
LogExpireDay Integer 审计日志保存时长。目前支持的值包括:[0,7,30,180,365,1095,1825]。
注意:此字段可能返回 null,表示取不到有效值。
LogType String 审计日志存储类型。目前支持的值包括:"storage" - 存储型。
IsClosing String 是否正在关闭审计。目前支持的值包括:"false"-否,"true"-是
CreateTime String 审计服务开通时间。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询审计服务配置

输入示例

https://cdb.tencentcloudapi.com/?Action=DescribeAuditConfig
&InstanceId=cdb-txcniupi
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
    "LogExpireDay": 365,
    "LogType": "storage",
    "IsClosing": "false",
    "CreateTime": "2021-07-13 11:34:35"
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.AuditConfigNotExist 审计不存在。
InternalError.DBError 数据库异常。
InternalError.DatabaseAccessError 数据库内部错误。
InvalidParameter.ControllerNotFoundError 未找到该接口。
OperationDenied.AuditPolicyNotExistError 审计策略不存在。
ResourceNotFound 资源不存在。
目录