使用DescribeAuditRecords查詢執行個體審計日誌-ApsaraDB for MongoDB-阿里雲 - ApsaraDB for MongoDB

查詢MongoDB執行個體的審計日誌。

介面說明

調用本介面時，執行個體的審計日誌須處於開通狀態，否則返回的審計日誌內容為空白。
本介面適用於規格類型為通用型本地碟版和獨享型本地碟版執行個體。
本介面限制每分鐘調用 30 次，如超過這個限制會被限流，請勿高頻調用。如需高頻調用，請使用 Logstore，詳情請參見管理 Logstore。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:DescribeAuditRecords

get

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。說明當本參數傳入的是分區叢集執行個體 ID 時，還需要傳入 NodeId 參數。	dds-bp12c5b040dc****
NodeId	string	否	分區叢集執行個體中 Mongos 節點 ID 或 Shard 節點 ID。說明當 DBInstanceId 參數傳入的是分區叢集執行個體 ID 時，本參數才可用。	d-bp128a003436****
StartTime	string	是	查詢開始時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2019-03-13T12:11:14Z
EndTime	string	是	查詢結束時間，必須晚於查詢開始時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。說明查詢結束時間距查詢開始時間不得超過 24 個小時，超過則調用失敗。	2019-03-13T13:11:14Z
Database	string	否	資料庫名，預設為所有資料庫。	database****
User	string	否	資料庫帳號，預設為所有帳號。	test
Form	string	否	審計記錄返回的展示類型，取值： File：觸發審計記錄檔的產生，若傳入這個值，只返回公用參數。 Stream（預設值）：返回資料流。說明 File 參數已廢棄	Stream
QueryKeywords	string	否	關鍵字查詢。多個關鍵字以空格分隔，不超過 10 個關鍵字。	slow
LogicalOperator	string	否	關鍵字搜尋的邏輯操作，預設值為 and。	and
PageSize	integer	否	每頁記錄數。取值：30（預設值）、50、100。	30
PageNumber	integer	否	頁碼。大於 0，且不超過 Integer 的最大值，預設值為 1。	1
OrderType	string	否	按時間的升降序對查詢到的慢日誌進行排序。取值： asc：按時間升序排序。 desc：按時間降序排序。	asc

返回參數

名稱	類型	描述	樣本值
	object	總記錄數。
TotalRecordCount	integer	總記錄數。	40
PageRecordCount	integer	當前頁最大記錄數。	30
RequestId	string	請求 ID。	3278BEB8-503B-4E46-8F7E-D26E040C9769
PageNumber	integer	頁碼。	1
Items	object
SQLRecord	array<object>	審計日誌詳情列表。
	object	執行個體資訊。
HostAddress	string	用戶端 IP 位址。	11.xxx.xxx.xxx
TableName	string	MongoDB 的集合名稱。	C1
ReturnRowCounts	integer	返回記錄數。	2
DBName	string	資料庫名。	test123
ExecuteTime	string	該語句執行的時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2019-03-11T03:30:27Z
ThreadID	string	線程 ID。	140682188297984
TotalExecutionTimes	integer	消耗時間，單位為微秒。	700
Syntax	string	執行語句。	{ \"atype\" : \"createCollection\", \"param\" : { \"ns\" : \"123.test1\" }, \"result\": \"OK\" }
AccountName	string	資料庫帳號名。	test

樣本

正常返回樣本

JSON格式

{
  "TotalRecordCount": 40,
  "PageRecordCount": 30,
  "RequestId": "3278BEB8-503B-4E46-8F7E-D26E040C9769",
  "PageNumber": 1,
  "Items": {
    "SQLRecord": [
      {
        "HostAddress": "11.xxx.xxx.xxx",
        "TableName": "C1",
        "ReturnRowCounts": 2,
        "DBName": "test123",
        "ExecuteTime": "2019-03-11T03:30:27Z",
        "ThreadID": "140682188297984",
        "TotalExecutionTimes": 700,
        "Syntax": "{ \\\"atype\\\" : \\\"createCollection\\\", \\\"param\\\" : { \\\"ns\\\" : \\\"123.test1\\\" }, \\\"result\\\": \\\"OK\\\" }",
        "AccountName": "test"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidStartTime.Format	Specified start time is not valid.	指定的開始時間無效。
400	InvalidEndTime.Format	Specified end time is not valid.
400	InvalidEndTime.Invalid	Specified end time is before this service active time.
400	InvalidParameterCombination	The end time must be greater than the start time.	結束時間必須大於開始時間。
400	InvalidQueryKeyword.Format	Specified Query Keyword is not valid.
400	InvalidDatabase.Format	Specified Database is not valid.
400	InvalidQueryTime.Format	Specified query time is not valid.
403	IncorrectSQLLogActiveStatus	Current DB instance SQL log active status does not support this operation.
403	LogApiFrequencyExceeded	Exceeding the allowed frequency of log api.
403	ConcurrentTaskExceeded	Concurrent task exceeding the allowed amount.

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

變更歷史

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