查詢集群的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 | *DBClusterLakeVersion acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 |
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 值是否正確。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-10-17 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-12-08 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |