查詢雲資料庫 Tair(相容 Redis)執行個體的審計日誌。
介面說明
調用本介面時,執行個體必須已開啟審計日誌,詳情請參見 ModifyAuditLogConfig 。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
kvstore:DescribeAuditRecords |
get |
*DBInstance
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| InstanceId |
string |
是 |
需要查詢的執行個體的 ID。 |
r-bp1zxszhcgatnx**** |
| NodeId |
string |
否 |
執行個體中的節點 ID。傳入本參數可查詢指定節點的監控資訊。 說明
|
r-bp1zxszhcgatnx****-db-0 |
| AccountName |
string |
否 |
帳號名稱,預設(不填任何值)表示查詢所有帳號。 |
demo |
| DatabaseName |
string |
否 |
執行個體中的 Database,預設(不填任何值)表示查詢所有 DB,取值為 0 ~ 255,樣本 0 表示 DB 0。 |
0 |
| QueryKeywords |
string |
否 |
根據指定的命令查詢審計日誌,預設查詢所有執行過的命令。 說明
只能傳入單個關鍵詞。 |
maxclients |
| HostAddress |
string |
否 |
用戶端 IP,預設(不填任何值)為查詢所有地址。 |
127.0.0.1 |
| PageSize |
integer |
否 |
每頁顯示的最大記錄數。 |
30 |
| PageNumber |
integer |
否 |
當前顯示的頁碼。 |
1 |
| StartTime |
string |
是 |
查詢開始時間,格式為yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 |
2019-03-24T12:10:00Z |
| EndTime |
string |
是 |
查詢結束時間,必須晚於查詢開始時間,格式為yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 說明
由於審計日誌的條目數較多,一般查詢的時間範圍建議在 10 分鐘以內,最長不超過 1 天。 |
2019-03-25T12:10:00Z |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| EndTime |
string |
查詢結束時間。 |
2019-03-25T12:10:00Z |
| StartTime |
string |
查詢開始時間。 |
2019-03-24T12:10:00Z |
| RequestId |
string |
請求 ID。 |
9F5EB478-824E-4AC4-8D2B-58F31A02**** |
| InstanceName |
string |
執行個體名稱。 |
r-bp1zxszhcgatnx**** |
| TotalRecordCount |
integer |
總記錄數。 |
22222 |
| PageNumber |
integer |
當前顯示的頁碼。 |
1 |
| PageSize |
integer |
每頁顯示的最大記錄數。 |
30 |
| Items |
object |
||
| SQL |
array<object> |
由審計日誌組成的集合。 |
|
|
object |
|||
| HostAddress |
string |
用戶端地址。 |
127.0.0.1 |
| SQLText |
string |
命令記錄。 |
CONFIG GET maxmemory |
| DatabaseName |
string |
資料庫名稱。 |
demo |
| SQLType |
string |
命令類型。 |
non_read_write |
| ExecuteTime |
string |
執行時間。 |
2019-03-25T03:22:08Z |
| TotalExecutionTimes |
string |
執行消耗時間。 |
0 |
| NodeId |
string |
節點 ID。 說明
執行個體為叢集或讀寫分離架構時,本參數才會返回具體的節點 ID。 |
r-bp1zxszhcgatnx****-db-0 |
| AccountName |
string |
帳號名稱。 |
demo |
| IPAddress |
string |
IP 位址。 |
192.16.100.*** |
樣本
正常返回樣本
JSON格式
{
"EndTime": "2019-03-25T12:10:00Z",
"StartTime": "2019-03-24T12:10:00Z",
"RequestId": "9F5EB478-824E-4AC4-8D2B-58F31A02****",
"InstanceName": "r-bp1zxszhcgatnx****",
"TotalRecordCount": 22222,
"PageNumber": 1,
"PageSize": 30,
"Items": {
"SQL": [
{
"HostAddress": "127.0.0.1",
"SQLText": "CONFIG GET maxmemory",
"DatabaseName": "demo",
"SQLType": "non_read_write",
"ExecuteTime": "2019-03-25T03:22:08Z",
"TotalExecutionTimes": "0",
"NodeId": "r-bp1zxszhcgatnx****-db-0",
"AccountName": "demo",
"IPAddress": "192.16.100.***"
}
]
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | IncorrectDBInstance.NotSupported | This instance do not support log audit. | 此執行個體不支援審計日誌相關服務 |
| 400 | InvalidEndTime.Invalid | pecified end time is before this service active time. | |
| 400 | InvalidStartTime.Malformed | The Specified parameter StartTime is not valid. | |
| 400 | InvalidEndTime.Malformed | The Specified parameter EndTime is not valid. | |
| 400 | InvalidPageSize.Malformed | The specified parameter PageSize is not valid. | |
| 400 | InvalidPageNumbers.Malformed | Specified page number is not valid. | |
| 400 | InvalidQueryTime.Format | Specified query time is not valid. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。