云数据库 MySQL 开通审计服务（数据库审计相关接口）

一、1. 接口描述

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

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

二、2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：OpenAuditService。
Version	是	String	公共参数，本接口取值：2017-03-20。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	CDB 实例 ID。可通过 DescribeDBInstances 接口获取。示例值：cdb-etxaaa12
LogExpireDay	是	Integer	审计日志保存时长。支持值包括：7 – 一周；30 – 一个月；90 – 三个月；180 – 六个月；365 – 一年；1095 – 三年；1825 – 五年。示例值：30
HighLogExpireDay	否	Integer	高频审计日志保存时长。默认值为7，此项取值需小于等于 LogExpireDay，支持值包括：3 – 3天；7 – 一周；30 – 一个月；90 – 三个月；180 – 六个月；365 – 一年；1095 – 三年；1825 – 五年。示例值：7
RuleTemplateIds.N	否	Array of String	规则模板 ID。示例值：["cdb-art-l1mlbo59"]
AuditAll	否	Boolean	审计类型。true – 全审计；默认 false – 规则审计。示例值：true

三、3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

四、示例1 开通实例审计服务

无

五、输入示例

POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: OpenAuditService
<公共请求参数>
{
"InstanceId": "cdb-3u8h3h1w",
"LogExpireDay": 30,
"HighLogExpireDay": 7,
"RuleTemplateIds": [
"cdb-art-l1mlbo59"
],
"AuditAll": true
}

六、输出示例

{
"Response": {
"RequestId": "43-12121-812w1221213-62usf6123"
}
}

七、腾讯云 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. 错误码

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

错误码	描述
FailedOperation.CreateAuditFailError	创建审计规则失败。
FailedOperation.InstanceQueryError	查询失败。
InternalError.DBError	数据库异常。
InternalError.HttpError	Http请求异常。
InternalError.UnknownError	未知错误。
InvalidParameter.ControllerNotFoundError	未找到该接口。
InvalidParameter.ExceptionParam	异常参数。
InvalidParameter.InvalidParameterError	无效的参数值。
InvalidParameterValue.InvalidParameterValueError	参数值无效。
OperationDenied.AuditStatusError	审计状态异常。
OperationDenied.AuditTaskConflictError	审计任务冲突。
OperationDenied.InstanceStatusError	实例状态异常。
OperationDenied.UnsupportOpenAuditError	不支持开通审计。
ResourceNotFound.InstanceNotFundError	该实例不存在。