查詢集群的SQL審計(jì)日志。
接口說明
- 僅當(dāng) SQL 審計(jì)狀態(tài)為開啟時,才能查詢到 SQL 審計(jì)日志,且只支持查詢 30 天內(nèi)的 SQL 審計(jì)日志。如果中途關(guān)閉了 SQL 審計(jì),再次打開時,僅能查詢到再次打開后的 SQL 審計(jì)日志。SQL 審計(jì)日志不記錄INSERT INTO VALUES、REPLACE INTO VALUES和UPSERT INTO VALUES操作。
- 當(dāng)前服務(wù)的接入地址請參見服務(wù)接入點(diǎn)。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 企業(yè)版、基礎(chǔ)版或湖倉版的集群 ID。 說明
您可以調(diào)用 DescribeDBClusters 接口查看目標(biāo)地域下所有的集群 ID。
| amv-t4nj8619bz2w3**** |
RegionId | string | 是 | 地域 ID。 說明
您可以調(diào)用 DescribeRegions 接口查看集群的地域 ID。
| cn-hangzhou |
StartTime | string | 是 | 查詢開始時間,UTC 時間,格式為:yyyy-MM-ddTHH:mmZ。 說明
僅當(dāng) SQL 審計(jì)狀態(tài)為開啟時,才能查詢到 SQL 審計(jì)日志,且只支持查詢 30 天內(nèi)的 SQL 審計(jì)日志。如果中途關(guān)閉了 SQL 審計(jì),再次打開時,僅能查詢到再次打開后的 SQL 審計(jì)日志。
| 2022-08-12T04:17Z |
EndTime | string | 是 | 查詢結(jié)束時間,UTC 時間,格式為:yyyy-MM-ddTHH:mmZ。 說明
| 2022-08-12T17:08Z |
DBName | string | 否 | 執(zhí)行目標(biāo) SQL 的數(shù)據(jù)庫名稱。 | adb_demo |
QueryKeyword | string | 否 | 可設(shè)置一個字符串類型的值,使用該值作為關(guān)鍵詞對返回結(jié)果進(jìn)行搜索。 | adb |
SqlType | string | 否 | SQL 類型,取值:
說明
每次僅允許傳入一種類型查詢,若該參數(shù)為空,默認(rèn)查詢 SELECT 類型。
| SELECT |
Succeed | string | 否 | 目標(biāo) SQL 是否執(zhí)行成功,取值說明:
| true |
HostAddress | string | 否 | 執(zhí)行目標(biāo) SQL 的客戶端 IP 地址和端口號。 | 100.104.XX.XX:43908 |
OrderType | string | 否 | 按 SQL 執(zhí)行時間進(jìn)行正序或倒序排序,取值說明:
| asc |
User | string | 否 | 執(zhí)行目標(biāo) SQL 的用戶名。 | test |
Order | string | 否 | 根據(jù)指定字段進(jìn)行排序,格式為 JSON,是一個有序 JSON 數(shù)組,按輸入數(shù)組的順序進(jìn)行復(fù)合排序,包含
| [{"Field":"ExecuteTime","Type":"Desc"},{"Field":"HostAddress","Type":"Asc"}] |
PageSize | integer | 否 | 每頁記錄數(shù),取值:
| 10 |
PageNumber | integer | 否 | 頁碼,取值為大于 0 且不超過 Integer 數(shù)據(jù)類型的最大值。默認(rèn)值為 1。 | 1 |
ProxyUser | string | 否 | 預(yù)留參數(shù)。 | 無 |
返回參數(shù)
示例
正常返回示例
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 不存在,請確認(rèn) DBClusterId 值是否正確。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2023-12-08 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |