查詢MongoDB實(shí)例的審計(jì)日志。
接口說明
- 調(diào)用本接口時(shí)，實(shí)例的審計(jì)日志須處于開通狀態(tài)，否則返回的審計(jì)日志內(nèi)容為空。
- 本接口適用于規(guī)格類型為通用型本地盤版和獨(dú)享型本地盤版實(shí)例。
- 本接口限制每分鐘調(diào)用 30 次，如超過這個(gè)限制會(huì)被限流，請勿高頻調(diào)用。如需高頻調(diào)用，請使用 Logstore，詳情請參見管理 Logstore。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別：是指每個(gè)操作的訪問級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| dds:DescribeAuditRecords | get |
|
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 實(shí)例 ID。 說明
當(dāng)本參數(shù)傳入的是分片集群實(shí)例 ID 時(shí)，還需要傳入 NodeId 參數(shù)。
| dds-bp12c5b040dc**** |
| NodeId | string | 否 | 分片集群實(shí)例中 Mongos 節(jié)點(diǎn) ID 或 Shard 節(jié)點(diǎn) ID。 說明
當(dāng) DBInstanceId 參數(shù)傳入的是分片集群實(shí)例 ID 時(shí)，本參數(shù)才可用。
| d-bp128a003436**** |
| StartTime | string | 是 | 查詢開始時(shí)間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時(shí)間）。 | 2019-03-13T12:11:14Z |
| EndTime | string | 是 | 查詢結(jié)束時(shí)間，必須晚于查詢開始時(shí)間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時(shí)間）。 說明
查詢結(jié)束時(shí)間距查詢開始時(shí)間不得超過 24 個(gè)小時(shí)，超過則調(diào)用失敗。
| 2019-03-13T13:11:14Z |
| Database | string | 否 | 數(shù)據(jù)庫名，默認(rèn)為所有數(shù)據(jù)庫。 | database**** |
| User | string | 否 | 數(shù)據(jù)庫賬號(hào)，默認(rèn)為所有賬號(hào)。 | test |
| Form | string | 否 | 審計(jì)記錄返回的展示類型，取值：
| Stream |
| QueryKeywords | string | 否 | 關(guān)鍵字查詢。多個(gè)關(guān)鍵字以空格分隔，不超過 10 個(gè)關(guān)鍵字。 | slow |
| LogicalOperator | string | 否 | 關(guān)鍵字搜索的邏輯操作， 默認(rèn)值為 and。 | and |
| PageSize | integer | 否 | 每頁記錄數(shù)。取值：30（默認(rèn)值）、50、100。 | 30 |
| PageNumber | integer | 否 | 頁碼。大于 0，且不超過 Integer 的最大值，默認(rèn)值為 1。 | 1 |
| OrderType | string | 否 | 按時(shí)間的升降序?qū)Σ樵兊降穆罩具M(jìn)行排序。取值：
| asc |
返回參數(shù)
示例
正常返回示例
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"
}
]
}
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidStartTime.Format | Specified start time is not valid. | 指定的開始時(shí)間無效。 |
| 400 | InvalidEndTime.Format | Specified end time is not valid. | EndTime（查詢結(jié)束時(shí)間）參數(shù)值格式不正確，請重新配置。格式要求：yyyy-MM-ddTHH:mmZ（UTC時(shí)間）。查詢結(jié)束時(shí)間必須晚于查詢開始時(shí)間。 |
| 400 | InvalidEndTime.Invalid | Specified end time is before this service active time. | - |
| 400 | InvalidParameterCombination | The end time must be greater than the start time. | 結(jié)束時(shí)間必須大于開始時(shí)間。 |
| 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. | 日志API訪問量超過允許上限。 |
| 403 | ConcurrentTaskExceeded | Concurrent task exceeding the allowed amount. | - |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-01-22 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |