全部产品
Search

搜索本产品

    云原生数据仓库AnalyticDB：DescribeAuditLogRecords - 查询集群的SQL审计日志

    文档中心

    云原生数据仓库AnalyticDB：DescribeAuditLogRecords - 查询集群的SQL审计日志

    更新时间：Dec 18, 2024

    调用DescribeAuditLogRecords接口查询数仓版集群的SQL审计日志。

    接口说明

    调用本接口查看 AnalyticDB MySQL 集群的 SQL 审计日志前，需要开启 SQL 审计。您可以调用 DescribeAuditLogConfig 接口查询 SQL 审计的开启状态，如未开启，可调用 ModifyAuditLogConfig 接口开启 SQL 审计。

    仅当 SQL 审计状态为开启时，才能查询到 SQL 审计日志，且只支持查询 30 天内的 SQL 审计日志。如果中途关闭了 SQL 审计，再次打开时，仅能查询到再次打开后的 SQL 审计日志。SQL 审计日志不记录INSERT INTO VALUES、REPLACE INTO VALUES和UPSERT INTO VALUES操作。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    adb:DescribeAuditLogRecordsget
    *DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    DBClusterIdstring是

    数仓版集群 ID。

    说明 您可以调用 DescribeDBClusters 接口查看目标地域下所有数仓版集群的集群 ID。
    		am-t4nj8619bz2w3****
    RegionIdstring是

    地域 ID。

    说明 您可以调用 DescribeRegions 接口查看 AnalyticDB MySQL 版支持的地域和可用区信息，包括地域 ID。
    		cn-hangzhou
    StartTimestring是

    查询开始时间，UTC 时间，格式为：yyyy-MM-ddTHH:mmZ。

    说明 仅当 SQL 审计状态为开启时，才能查询到 SQL 审计日志，且只支持查询 30 天内的 SQL 审计日志。如果中途关闭了 SQL 审计，再次打开时，仅能查询到再次打开后的 SQL 审计日志。
    		2022-01-23T02:18Z
    EndTimestring是

    查询结束时间，UTC 时间，格式为：yyyy-MM-ddTHH:mmZ。

    说明
  • 查询结束时间需晚于查询开始时间。
  • 查询开始时间与查询结束时间的间隔不能超过 24 小时。
    •
    		2022-01-23T22:18Z
    DBNamestring否

    执行 SQL 的数据库名称。

    		adb_demo
    QueryKeywordstring否

    对查询包含目标关键字的 SQL 进行查询。

    		adb
    SqlTypestring否

    SQL 类型，取值：

    • DELETE
    • SELECT
    • UPDATE
    • INSERT_INTO_SELECT
    • ALTER
    • DROP
    • CREATE
    说明 每次仅允许传入一种类型查询，若该参数为空，默认查询所有类型。
    		SELECT
    Succeedstring否

    目标 SQL 是否执行成功，取值说明：

    • true：执行成功。
    • false：执行失败。
    		true
    HostAddressstring否

    执行目标 SQL 的客户端 IP 地址和端口号。

    		100.104.XX.XX:43908
    OrderTypestring否

    按 SQL 执行时间进行正序或倒序排序，取值说明：

    • asc：正序。
    • desc：倒序。
    		asc
    Userstring否

    执行目标 SQL 的用户名。

    		test_user
    Orderstring否

    根据指定字段进行排序，格式为 JSON，是一个有序 JSON 数组，按输入数组的顺序进行复合排序，包含 Field 和 Type 两个字段。

    • Field 表示需要排序的字段名，取值说明：
      • HostAddress：连接数据库的客户端地址。
      • Succeed：目标 SQL 是否执行成功。
      • TotalTime：目标 SQL 的执行总耗时。
      • DBName：执行目标 SQL 的数据库名称。
      • SQLType：SQL 类型。
      • User：执行目标 SQL 的用户名。
      • ExecuteTime：目标 SQL 的执行开始时间。
    • Type 表示排序类型，取值说明：
      • Desc：降序。
      • Asc：升序。
    		[{"Field":"ExecuteTime","Type":"Desc"},{"Field":"HostAddress","Type":"Asc"}]
    PageSizeinteger否

    每页记录数，取值：

    • 10
    • 30
    • 50
    • 100
    说明 本参数不填写时，默认为 10。
    		10
    PageNumberinteger否

    页码，取值为大于 0 且不超过 Integer 数据类型的最大值。默认值为 1。

    		1

    返回参数

    名称类型描述示例值
    object

    详情。

    TotalCountstring

    总记录数。

    		1
    PageSizestring

    每页记录数。

    		10
    RequestIdstring

    请求 ID。

    		8A564B7F-8C00-43C0-8EC5-919FBB70573
    PageNumberstring

    页码。

    		1
    DBClusterIdstring

    集群 ID。

    		am-t4nj8619bz2w3****
    Itemsarray<object>

    SQL 审计日志详情。

    SlowLogRecordobject

    列表。

    HostAddressstring

    执行目标 SQL 的客户端 IP 地址和端口号。

    		100.104.XX.XX:43908
    Succeedstring

    目标 SQL 是否执行成功。取值说明：

    • true：执行成功。
    • false：执行失败。
    		true
    SQLTextstring

    SQL 语句详情。

    		SELECT * FROM tb_courses
    TotalTimestring

    目标 SQL 的执行时长，单位：毫秒（ms）。

    		216
    ConnIdstring

    此参数无效。

    		无
    DBNamestring

    执行目标 SQL 的数据库名称。

    		adb_test
    SQLTypestring

    目标 SQL 的类型。

    		SELECT
    ExecuteTimestring

    目标 SQL 的执行开始时间，本地时间，格式为：yyyy-MM-dd HH:mm:ss。

    		2022-01-23 16:05:08
    ProcessIDstring

    任务 ID。

    		202106081752021720161662490345362390
    Userstring

    执行目标 SQL 的用户名。

    		test_user

    示例

    正常返回示例

    JSON格式

    {
  "TotalCount": "1",
  "PageSize": "10",
  "RequestId": "8A564B7F-8C00-43C0-8EC5-919FBB70573",
  "PageNumber": "1",
  "DBClusterId": "am-t4nj8619bz2w3****",
  "Items": [
    {
      "HostAddress": "100.104.XX.XX:43908",
      "Succeed": "true",
      "SQLText": "SELECT * FROM tb_courses",
      "TotalTime": "216",
      "ConnId": "无",
      "DBName": "adb_test",
      "SQLType": "SELECT",
      "ExecuteTime": "2022-01-23 16:05:08",
      "ProcessID": "202106081752021720161662490345362390",
      "User": "test_user"
    }
  ]
}

    错误码

    HTTP status code错误码错误信息描述
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2024-01-05OpenAPI 错误码发生变更查看变更详情