一、1. 接口描述
开启数据库审计服务
默认接口请求频率限制:20次/秒。
二、2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数,本接口取值:OpenAuditService。 |
| Version | 是 | String | 公共参数,本接口取值:2021-05-27。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Product | 是 | String | 服务产品类型,支持值包括: "dcdb" – 云数据库 Tdsql, "mariadb" – 云数据库 MariaDB。示例值:dcdb |
| NodeRequestType | 是 | String | 与Product保持一致。如:"dcdb" ,"mariadb"。示例值:dcdb |
| InstanceId | 是 | String | 实例ID。示例值:tdsql-njshdu |
| LogExpireDay | 是 | Integer | 日志保存总时长,只能是7,30,90,180,365,1095,1825。示例值:30 |
| HotLogExpireDay | 是 | Integer | 高频日志保存时长,只能是7,30,90,180,365,1095,1825。示例值:7 |
三、3. 输出参数
| 参数名称 | 类型 | 描述 |
| TaskId | Integer | taskId 为0表示开通审计成功,否则开通失败示例值:0 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
四、示例1 开通数据库审计
开通数据库审计后,将会上报审计日志
五、输入示例
https://dbbrain.tencentcloudapi.com/?Action=OpenAuditService
&Product=dcdb
&NodeRequestType=dcdb
&InstanceId=tdsqlsertsd
&LogExpireDay=30
&HotLogExpireDay=7
&<公共请求参数>
六、输出示例
{
"Response": {
"TaskId": 0,
"RequestId": "b39db780-0b49-11ee-8525-17d65d16bdaf"
}
}
七、腾讯云 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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| FailedOperation.PaasAuditNotOpened | paas 侧商业审计状态未开启 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.UserHasNoStrategy | CAM鉴权错误。 |
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |