TDSQL-C MySQL 版获取审计实例列表-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口（DescribeAuditInstanceList）用于获取数据库审计的实例列表。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAuditInstanceList。
Version	是	String	公共参数，本接口取值：2019-01-07。
Region	是	String	公共参数，详见产品支持的地域列表。
AuditSwitch	否	Integer	实例审计开启的状态。1-已开启审计；0-未开启审计。示例值：1
Filters.N	否	Array of AuditInstanceFilters	查询实例列表的过滤条件。示例值：[{"Name": "InstanceId","ExactMatch": true,"Values": ["cynosdbmysql-ins-ifq10fec"]}]
AuditMode	否	Integer	实例的审计规则模式。1-规则审计；0-全审计。示例值：1
Limit	否	Integer	单次请求返回的数量。默认值为30，最大值为 100。示例值：10
Offset	否	Integer	偏移量，默认值为 0。示例值：1

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合查询条件的实例总数。示例值：2
Items	Array of InstanceAuditStatus	审计实例详细信息列表。注意：此字段可能返回 null，表示取不到有效值。示例值：[{"AuditAll": true,"AuditStatus": "ON","BillingAmount": 0,"CreateAt": "2024-08-07 20:36:59","Deliver": "OFF","DeliverSummary": [],"HighLogExpireDay": 7,"HighRealStorage": 0,"InstanceId": "cynosdbmysql-ins-3v52nx11","InstanceInfo": {"ProjectId": 0,"TagList": []},"LogExpireDay": 30,"LowLogExpireDay": 23,"LowRealStorage": 0,"RealStorage": 0,"RuleTemplateIds": cynosdb-art-c1jo4q11}]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取审计实例列表

获取审计实例列表

输入示例

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

{
    "AuditMode": 0,
    "Limit": 1,
    "Filters": [
        {
            "Values": [
                "cynosdbmysql-ins-6990cckk"
            ],
            "Name": "InstanceId",
            "ExactMatch": true
        }
    ],
    "AuditSwitch": 0,
    "Offset": 1
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "43-12121-812w1221213-62usf9093",
        "Items": [
            {
                "RealStorage": 0,
                "BillingAmount": 0,
                "LowRealStorage": 0,
                "InstanceId": "cynosdbmysql-ins-6990cckk",
                "CreateAt": "2022-03-02 10:09:08",
                "AuditStatus": "1",
                "LogExpireDay": 1,
                "AuditAll": true,
                "InstanceInfo": {
                    "ProjectId": 0,
                    "TagList": [
                        {
                            "TagKey": "name",
                            "TagValue": "zhang"
                        }
                    ]
                },
                "HighRealStorage": 0,
                "HighLogExpireDay": 30,
                "LowLogExpireDay": 7
            }
        ]
    }
}

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.HttpError	网络错误