云数据库 MySQL 查询审计策略-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口(DescribeAuditPolicies)用于查询云数据库实例的审计策略。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAuditPolicies。
Version	是	String	公共参数，本接口取值：2017-03-20。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	否	String	实例 ID，格式如：cdb-c1nl9rpv 或者 cdbro-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。示例值：cdb-qwerasdf
PolicyId	否	String	审计策略 ID。示例值：cdbpolicy-asdfqwer
PolicyName	否	String	审计策略名称。支持按审计策略名称进行模糊匹配查询。示例值：full
Limit	否	Integer	分页大小参数。默认值为 20，最小值为 1，最大值为 100。示例值：10
Offset	否	Integer	分页偏移量。示例值：0
RuleId	否	String	审计规则 ID。可使用该审计规则 ID 查询到其关联的审计策略。注意，参数 RuleId，InstanceId，PolicyId，PolicyName 必须至少传一个。示例值：test
InstanceName	否	String	实例名称示例值：cdb

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合条件的审计策略个数。示例值：1
Items	Array of AuditPolicy	审计策略详情。注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询审计策略

输入示例

https://cdb.tencentcloudapi.com/?Action=DescribeAuditPolicies
&InstanceId=cdb-qwerasdf
&PolicyId=cdbpolicy-asdfqwer
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "TotalCount": 1,
        "Items": [
            {
                "PolicyId": "cdbpolicy-asdfqwer",
                "Status": "running",
                "InstanceId": "cdb-qwerasdf",
                "InstanceName": "test",
                "CreateTime": "2019-03-20 17:09:13",
                "ModifyTime": "2019-03-20 17:09:13",
                "PolicyName": "audit_policy_1",
                "RuleId": "cdbrule-asdfqwer",
                "RuleName": "audit1"
            }
        ]
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError.DatabaseAccessError	数据库内部错误。
InternalError.InnerCommonError	内部服务错误。
InternalError.ServerError	系统内部错误。
InternalError.TransactionBeginError	操作失败。
InternalError.UnknownError	未知错误。
InvalidParameter.ControllerNotFoundError	未找到该接口。
InvalidParameterValue.InvalidParameterValueError	参数值无效。
MissingParameter	缺少参数错误。
MissingParameter.MissingParamError	缺少必要参数。

查询审计策略

本页目录：