有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

CDB实例开通审计服务

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:OpenAuditService。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String CDB实例ID
示例值:cdb-etxaaa12
LogExpireDay Integer 审计日志保存时长。支持值包括:
7 - 一周
30 - 一个月;
90 - 三个月;
180 - 六个月;
365 - 一年;
1095 - 三年;
1825 - 五年;
示例值:30
HighLogExpireDay Integer 高频审计日志保存时长。支持值包括:
7 - 一周
30 - 一个月;
示例值:7
AuditRuleFilters.N Array of AuditRuleFilters 审计规则。同RuleTemplateIds都不填是全审计。
RuleTemplateIds.N Array of String 规则模板ID。同AuditRuleFilters都不填是全审计。
示例值:["cdb-art-l1mlbo59"]
AuditAll Boolean 审计类型。true-全审计;默认false-规则审计。
示例值:true

3. 输出参数

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

4. 示例

示例1 开通实例审计服务

输入示例

POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: OpenAuditService
<公共请求参数>

{
    "InstanceId": "cdb-3u8h3h1w",
    "LogExpireDay": 30,
    "HighLogExpireDay": 7,
    "AuditRuleFilters": [
        {
            "RuleFilters": [
                {
                    "Compare": "NEQ",
                    "Type": "host",
                    "Value": [
                        "127.0.0.1"
                    ]
                }
            ]
        }
    ]
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CreateAuditFailError 创建审计规则失败。
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 该实例不存在。