1. 接口描述
接口请求域名: cdb.tencentcloudapi.com 。
本接口(CreateAuditPolicy)用于创建云数据库实例的审计策略,即将审计规则绑定到具体的云数据库实例上。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateAuditPolicy。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Name | 是 | String | 审计策略名称。 示例值:audit_policy_1 |
RuleId | 是 | String | 审计规则 ID。 示例值:cdbrule-asdfghjk |
InstanceId | 是 | String | 实例 ID,格式如:cdb-c1nl9rpv 或者 cdbro-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。 示例值:cdb-qwerasdf |
LogExpireDay | 否 | Integer | 审计日志保存时长。支持值包括: 7 - 一周 30 - 一个月; 180 - 六个月; 365 - 一年; 1095 - 三年; 1825 - 五年; 实例首次开通审计策略时,可传该值,用于设置存储日志保存天数,默认为 30 天。若实例已存在审计策略,则此参数无效,可使用 更改审计服务配置 接口修改日志存储时长。 示例值:7 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
PolicyId | String | 审计策略 ID。 示例值:cdbpolicy-asdfqwer |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建审计策略
输入示例
https://cdb.tencentcloudapi.com/?Action=CreateAuditPolicy
&Name=audit_policy_1
&RuleId=cdbrule-asdfghjk
&InstanceId=cdb-qwerasdf
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"PolicyId": "cdbpolicy-asdfqwer"
}
}
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.CreateAuditFailError | 创建审计规则失败。 |
FailedOperation.TypeInConflict | 类型错误,无法执行该操作。 |
InternalError.AuditError | 审计内部服务错误。 |
InternalError.AuditOssLogicError | 审计服务内部异常。 |
InternalError.DBError | 数据库异常。 |
InternalError.DBOperationError | 数据库操作失败。 |
InternalError.DatabaseAccessError | 数据库内部错误。 |
InternalError.HttpError | Http请求异常。 |
InternalError.InternalHttpServerError | 请求执行异常。 |
InternalError.ServerError | 系统内部错误。 |
InternalError.ServiceError | 内部服务异常。 |
InternalError.TransactionBeginError | 操作失败。 |
InternalError.UnknownError | 未知错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidParameterError | 无效的参数值。 |
InvalidParameterValue.InvalidParameterValueError | 参数值无效。 |
LimitExceeded | 超过配额限制。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.AuditPolicyConflictError | 审计策略冲突。 |
OperationDenied.AuditPolicyExistError | 审计策略已存在。 |
OperationDenied.AuditPolicyOverQuotaError | 审计策略数量超限。 |
OperationDenied.AuditRuleHasBind | 审计规则已绑定。 |
OperationDenied.AuditRuleNotExistError | 审计规则不存在。 |
OperationDenied.AuditStatusError | 审计状态异常。 |
OperationDenied.AuditTaskConflictError | 审计任务冲突。 |
OperationDenied.DBBrainPolicyConflict | 已开通安全审计,不支持规则审计。 |
OperationDenied.InstanceStatusError | 实例状态异常。 |
OperationDenied.UnsupportOpenAuditError | 不支持开通审计。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.InstanceNotFundError | 该实例不存在。 |
ResourceUnavailable | 资源不可用。 |
UnsupportedOperation | 操作不支持。 |