1. 接口描述
接口请求域名: cdb.tencentcloudapi.com 。
本接口(CreateAuditLogFile)用于创建云数据库实例的审计日志文件。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateAuditLogFile。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例 ID,与云数据库控制台页面中显示的实例 ID 相同。 示例值:cdb-cdtkp3hr |
StartTime | 是 | String | 开始时间。 示例值:2023-06-07 15:59:45 |
EndTime | 是 | String | 结束时间。 示例值:2023-06-16 14:27:00 |
Order | 否 | String | 排序方式。支持值包括:"ASC" - 升序,"DESC" - 降序。 示例值:DESC |
OrderBy | 否 | String | 排序字段。支持值包括: "timestamp" - 时间戳; "affectRows" - 影响行数; "execTime" - 执行时间。 示例值:timestamp |
Filter | 否 | AuditLogFilter | 已废弃。 |
LogFilter.N | 否 | Array of InstanceAuditLogFilters | 过滤条件。可按设置的过滤条件过滤日志。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FileName | String | 审计日志文件名称。 示例值:*.csv |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建审计日志文件
查询审计日志成功
输入示例
https://cdb.tencentcloudapi.com/?Action=CreateAuditLogFile
&InstanceId=cdb-qwerasdf
&StartTime=2017-07-12 10:29:20
&EndTime=2017-07-13 10:29:20
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"FileName": "test.csv"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.CreateAuditLogFileError | 创建审计日志文件失败。 |
InternalError.AuditCreateLogFileError | 创建审计日志文件错误。 |
InternalError.DBError | 数据库异常。 |
InternalError.DatabaseAccessError | 数据库内部错误。 |
InternalError.ExecHttpRequestError | 执行http请求错误。 |
InternalError.InternalHttpServerError | 请求执行异常。 |
InternalError.ServerError | 系统内部错误。 |
InternalError.TransactionBeginError | 操作失败。 |
InternalError.UnknownError | 未知错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ExceptionParam | 异常参数。 |
InvalidParameter.InvalidParameterError | 无效的参数值。 |
InvalidParameter.JsonUnmarshalError | Json反序列化错误。 |
InvalidParameterValue.DataConvertError | 数据转换失败。 |
InvalidParameterValue.InvalidParameterValueError | 参数值无效。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.AuditFileOverQuotaError | 审计日志文件数超过最大限制数。 |
OperationDenied.AuditPolicyNotExistError | 审计策略不存在。 |
OperationDenied.OverQuota | 资源配额超限。 |
OverQuota | 超限错误。 |
ResourceUnavailable | 资源不可用。 |