DescribeAuditLogRecords - 查詢叢集的SQL審計日誌 - AnalyticDB

調用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:DescribeAuditLogRecords

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

無

請求參數

名稱	類型	必填	描述	樣本值
DBClusterId	string	是	數倉版叢集 ID。說明您可以調用 DescribeDBClusters 介面查看目標地區下所有數倉版叢集的叢集 ID。	am-t4nj8619bz2w3****
RegionId	string	是	地區 ID。說明您可以調用 DescribeRegions 介面查看 AnalyticDB MySQL 版支援的地區和可用性區域資訊，包括地區 ID。	cn-hangzhou
StartTime	string	否	查詢開始時間，UTC 時間，格式為：yyyy-MM-ddTHH:mmZ。說明僅當 SQL 審計狀態為開啟時，才能查詢到 SQL 審計日誌，且只支援查詢 30 天內的 SQL 審計日誌。如果中途關閉了 SQL 審計，再次開啟時，僅能查詢到再次開啟後的 SQL 審計日誌。	2022-01-23T02:18Z
EndTime	string	否	查詢結束時間，UTC 時間，格式為：yyyy-MM-ddTHH:mmZ。說明查詢結束時間需晚於查詢開始時間。查詢開始時間與查詢結束時間的間隔不能超過 24 小時。	2022-01-23T22:18Z
DBName	string	否	執行 SQL 的資料庫名稱。	adb_demo
QueryKeyword	string	否	對查詢包含目標關鍵字的 SQL 進行查詢。	adb
SqlType	string	否	SQL 類型，取值： DELETE SELECT UPDATE INSERT_INTO_SELECT ALTER DROP CREATE 說明每次僅允許傳入一種類型查詢，若該參數為空白，預設查詢所有類型。	SELECT
Succeed	string	否	目標 SQL 是否執行成功，取值說明： true：執行成功。 false：執行失敗。	true
HostAddress	string	否	執行目標 SQL 的用戶端 IP 位址和連接埠號碼。	100.104.XX.XX:43908
OrderType	string	否	按 SQL 執行時間進行正序或倒序排序，取值說明： asc：正序。 desc：倒序。	asc
User	string	否	執行目標 SQL 的使用者名稱。	test_user
Order	string	否	根據指定欄位進行排序，格式為 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"}]
PageSize	integer	否	每頁記錄數，取值： 10 30 50 100 說明本參數不填寫時，預設為 10。	10
PageNumber	integer	否	頁碼，取值為大於 0 且不超過整數資料類型的最大值。預設值為 1。	1

返回參數

名稱	類型	描述	樣本值
	object	詳情。
TotalCount	string	總記錄數。	1
PageSize	string	每頁記錄數。	10
RequestId	string	請求 ID。	8A564B7F-8C00-43C0-8EC5-919FBB70573
PageNumber	string	頁碼。	1
DBClusterId	string	叢集 ID。	am-t4nj8619bz2w3****
Items	array<object>	SQL 審計日誌詳情。
	object	列表。
HostAddress	string	執行目標 SQL 的用戶端 IP 位址和連接埠號碼。	100.104.XX.XX:43908
Succeed	string	目標 SQL 是否執行成功。取值說明： true：執行成功。 false：執行失敗。	true
SQLText	string	SQL 陳述式詳情。	SELECT * FROM tb_courses
TotalTime	string	目標 SQL 的執行時間長度，單位：毫秒（ms）。	216
ConnId	string	此參數無效。	無
DBName	string	執行目標 SQL 的資料庫名稱。	adb_test
SQLType	string	目標 SQL 的類型。	SELECT
ProcessID	string	任務 ID。	202106081752021720161662490345362390
User	string	執行目標 SQL 的使用者名稱。	test_user
ExecuteTime	string	目標 SQL 的執行開始時間，本地時間，格式為：yyyy-MM-dd HH:mm:ss。	2022-01-23 16:05:08
ExecuteTimestamp	integer

樣本

正常返回樣本

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",
      "ProcessID": "202106081752021720161662490345362390",
      "User": "test_user",
      "ExecuteTime": "2022-01-23 16:05:08",
      "ExecuteTimestamp": 0
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，請確認 DBClusterId 值是否正確。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。