查詢實例的SQL洞察（SQL審計）日志
更新時間 2022-11-22 11:33:53
最近更新時間: 2022-11-22 11:33:53
分享文章
接口描述
查詢RDS實例的SQL洞察（SQL審計）日志
接口約束
URI
GET /v1/collector/sql-log-records
請求參數
請求體Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| prodInstId | 是 | Long | 實例id | 10 | |
| pageNum | 是 | Integer | 頁碼最小值為1 | 1 | |
| pageSize | 是 | Integer | 頁大小取值范圍為：1-500 | 10 | |
| dbName | 否 | String | 數據庫名稱。默認為所有數據庫，也可以輸入數據庫名稱查詢，一次只能輸入一個 | test | |
| accountName | 否 | String | 用戶名稱。默認為所有用戶，也可以輸入用戶名稱查詢，一次只能輸入一個 | root | |
| startTime | 是 | String | 查詢開始時間,格式：yyyy-MM-dd HH:mm:ss | ||
| endTime | 是 | String | 查詢結束時間,大于查詢開始時間，與查詢開始時間間隔小于等于30天,格式：yyyy-MM-dd HH:mm:ss | ||
| queryKeywords | 否 | List |
用于查詢的關鍵字,??1.多個關鍵字以空格分隔，不超過10個關鍵字??2.如果SQL語句中的字段名使用了反引號（`），以該字段名作為查詢的關鍵字時，也需要輸入反引號。例如，字段名為`id`，則輸入`id`，而不是id | SELECT |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 狀態碼 | 800 | |
| message | String | 消息提示 | SUCCESS | |
| returnObj | PageVO | 返回對象 |
PageVO
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| pageNum | Integer | 頁碼 | 1 | |
| pageSize | Integer | 頁大小 | 10 | |
| pageTotal | Integer | 總頁數 | 1 | |
| total | Integer | 總記錄數 | 2 | |
| list | List |
記錄 | DescribeSQLLogRecordsVO |
DescribeSQLLogRecordsVO
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| hostAddress | String | 連接數據庫的客戶端IP地址 | 192.168.0.18:50744 | |
| sqlText | String | SQL語句 | terminating connection due to administrator command | |
| dbName | String | 數據庫名稱 | postgres | |
| executeTime | Long | 執行時間 | 1667354445000 | |
| threadId | String | 線程id | 6952 | |
| accountName | String | 執行操作的賬號名稱 | test |
請求示例
/v1/collector/sql-log-records?pageSize=10&pageNum-11-01 00:00:00&endTime=2022-11-29 23:59:59&prodInstId=10
請求體body
響應示例
{
"message": "SUCCESS",
"returnObj": {
"list": [
{
"accountName": "test",
"dbName": "postgres",
"executeTime": 1667354445000,
"hostAddress": "192.168.0.18:50744",
"sqlText": "terminating connection due to administrator command",
"threadId": "6952"
}
],
"pageNum": 1,
"pageSize": 10,
"pageTotal": 1,
"total": 1
},
"statusCode": 800
}
錯誤碼
訪問ErrorCodes說明文檔查看更多錯誤碼。
