DescribeAuditRecords - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries the audit logs of an ApsaraDB for MongoDB instance.

Operation description

When you call this operation, ensure that the audit log feature of the instance is enabled. Otherwise, the operation returns an empty audit log.
This operation is applicable only to general-purpose local-disk and dedicated local-disk instances.
You can call this operation up to 30 times per minute. To call this operation at a higher frequency, use a Logstore. For more information, see Manage a Logstore.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. Note If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter.	dds-bp12c5b040dc****
NodeId	string	No	The ID of the mongos node or shard node in the instance. Note This parameter takes effect only when you set the DBInstanceId parameter to the ID of a sharded cluster instance.	d-bp128a003436****
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2019-03-13T12:11:14Z
EndTime	string	Yes	The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note The end time must be within 24 hours from the start time. Otherwise, the query fails.	2019-03-13T13:11:14Z
Database	string	No	The name of the database to be queried. By default, all databases are queried.	database****
User	string	No	The user of the database. If you do not specify this parameter, this operation returns records of all users.	test
Form	string	No	The form of the audit log that the operation returns. Valid values: File: triggers the generation of audit logs. If this parameter is set to File, only common parameters are returned. Stream (default): returns data streams.	Stream
QueryKeywords	string	No	The keywords used for query. You can enter up to 10 keywords at a time. If you enter multiple keywords, separate the keywords with spaces.	slow
LogicalOperator	string	No	The logical relationship between multiple keywords. Valid values: or and (default value)	and
PageSize	integer	No	The number of entries to return per page. Default value: 30. Valid values: 30, 50, and 100.	30
PageNumber	integer	No	The page number of the page to return. The valid value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: 1.	1
OrderType	string	No	The order of time in which the log entries to return are sorted. Valid values: asc: The log entries are sorted by time in ascending order. desc: The log entries are sorted by time in descending order.	asc

Response parameters

Parameter	Type	Description	Example
	object
TotalRecordCount	integer	The total number of returned entries.	40
PageRecordCount	integer	The maximum number of entries on the current page.	30
RequestId	string	The request ID.	3278BEB8-503B-4E46-8F7E-D26E040C9769
PageNumber	integer	The page number of the returned page.	1
Items	array<object>	An array that consists of the information of audit log entries.
	object	The details of the instance.
HostAddress	string	The IP addresses of the client.	11.xxx.xxx.xxx
TableName	string	The name of the collection.	C1
ReturnRowCounts	long	The number of SQL audit log entries that are returned.	2
DBName	string	The name of the database.	test123
ExecuteTime	string	The time when the statement was executed. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-03-11T03:30:27Z
ThreadID	string	The ID of the thread.	140682188297984
TotalExecutionTimes	long	The duration of the statement execution. Unit: microseconds.	700
Syntax	string	The statement that was executed.	{ \"atype\" : \"createCollection\", \"param\" : { \"ns\" : \"123.test1\" }, \"result\": \"OK\" }
AccountName	string	The account of the database.	test

Examples

Sample success responses

JSONformat

{
  "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"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Format	Specified start time is not valid.	The specified start time is invalid.
400	InvalidEndTime.Format	Specified end time is not valid.	The specified EndTime parameter is invalid. Specify a valid end time point in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. The end time must be later than the start time.
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.	Maximum number of log API operations exceeded.
403	ConcurrentTaskExceeded	Concurrent task exceeding the allowed amount.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-01-22	The Error code has changed. The request parameters of the API has changed	View Change Details