查询集群的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:DescribeAuditLogRecords | list |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 企业版、基础版或湖仓版的集群 ID。 说明
您可以调用 DescribeDBClusters 接口查看目标地域下所有的集群 ID。
| amv-t4nj8619bz2w3**** |
RegionId | string | 是 | 地域 ID。 说明
您可以调用 DescribeRegions 接口查看集群的地域 ID。
| cn-hangzhou |
StartTime | string | 是 | 查询开始时间,UTC 时间,格式为:yyyy-MM-ddTHH:mmZ。 说明
仅当 SQL 审计状态为开启时,才能查询到 SQL 审计日志,且只支持查询 30 天内的 SQL 审计日志。如果中途关闭了 SQL 审计,再次打开时,仅能查询到再次打开后的 SQL 审计日志。
| 2022-08-12T04:17Z |
EndTime | string | 是 | 查询结束时间,UTC 时间,格式为:yyyy-MM-ddTHH:mmZ。 说明
| 2022-08-12T17:08Z |
DBName | string | 否 | 执行目标 SQL 的数据库名称。 | adb_demo |
QueryKeyword | string | 否 | 可设置一个字符串类型的值,使用该值作为关键词对返回结果进行搜索。 | adb |
SqlType | string | 否 | SQL 类型,取值:
说明
每次仅允许传入一种类型查询,若该参数为空,默认查询 SELECT 类型。
| SELECT |
Succeed | string | 否 | 目标 SQL 是否执行成功,取值说明:
| true |
HostAddress | string | 否 | 执行目标 SQL 的客户端 IP 地址和端口号。 | 100.104.XX.XX:43908 |
OrderType | string | 否 | 按 SQL 执行时间进行正序或倒序排序,取值说明:
| asc |
User | string | 否 | 执行目标 SQL 的用户名。 | test |
Order | string | 否 | 根据指定字段进行排序,格式为 JSON,是一个有序 JSON 数组,按输入数组的顺序进行复合排序,包含
| [{"Field":"ExecuteTime","Type":"Desc"},{"Field":"HostAddress","Type":"Asc"}] |
PageSize | integer | 否 | 每页记录数,取值:
| 10 |
PageNumber | integer | 否 | 页码,取值为大于 0 且不超过 Integer 数据类型的最大值。默认值为 1。 | 1 |
ProxyUser | string | 否 | 预留参数。 | 无 |
返回参数
示例
正常返回示例
JSON
格式
{
"TotalCount": "6974",
"PageSize": "10",
"RequestId": "8A564B7F-8C00-43C0-8EC5-919FBB70573",
"PageNumber": "1",
"DBClusterId": "amv-t4nj8619bz2w3****",
"Items": [
{
"HostAddress": "100.104.XX.XX:43908",
"Succeed": "true",
"SQLText": "SELECT * FROM adb_hdfs_import_source",
"TotalTime": "216",
"ConnId": "14356****",
"DBName": "adb_demo",
"SQLType": "SELECT",
"ExecuteTime": "2022-08-12 10:10:00",
"ProcessID": "202106081752021720161662490345362390",
"User": "test"
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-12-08 | OpenAPI 错误码发生变更 | 查看变更详情 |