All Products
Document Center


Last Updated: Dec 08, 2017


Currently, this API supports replica set instances only.

Request parameters

NameTypeRequired or notDescription
ActionStringYesRequired parameter; value: DescribeAuditRecords.
DBInstanceIdStringYesName of the primary instance
NodeIdStringNo- The Sharding parameter can be set to display Mongos ID or shard ID. If this parameter is left blank, both IDs are displayed.
- The replica is not required.

Response parameters

Public response parameters-For more information, see public response parameters.
TotalRecordCountIntegerTotal number of records
PageNumberIntegerPage number
PageRecordCountIntegerNumber of records on the current page
ItemsList<LogFile>Array composed of audit files

Log file parameters

FileIDIntergerDocument ID
DBInstanceIdStringInstance name
LogStatus String String- Success: Archiving is successful.
- Failed: Archiving fails.
- Generating: Archiving is being executed.
- Initializing: Archiving is not started.
LogStartTimeStringStart time and end time of audit logs
LogEndTimeStringStart time of audit logs
LogDownloadURLStringDownload URL. The URL is a null string if the audit logs cannot be downloaded temporarily.
LogSizeLongLog file size in bytes.