Description
Currently, this API supports replica set instances only.
Request parameters
| Name | Type | Required or not | Description |
|---|---|---|---|
| Action | String | Yes | Required parameter; value: DescribeAuditRecords. |
| DBInstanceId | String | Yes | Name of the primary instance |
| NodeId | String | No | - 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
| Name | Type | Description |
|---|---|---|
| Public response parameters | - | For more information, see public response parameters. |
| TotalRecordCount | Integer | Total number of records |
| PageNumber | Integer | Page number |
| PageRecordCount | Integer | Number of records on the current page |
| Items | List<LogFile> | Array composed of audit files |
Log file parameters
| Name | Type | Description |
|---|---|---|
| FileID | Interger | Document ID |
| DBInstanceId | String | Instance name |
| LogStatus String | String | - Success: Archiving is successful. - Failed: Archiving fails. - Generating: Archiving is being executed. - Initializing: Archiving is not started. |
| LogStartTime | String | Start time and end time of audit logs |
| LogEndTime | String | Start time of audit logs |
| LogDownloadURL | String | Download URL. The URL is a null string if the audit logs cannot be downloaded temporarily. |
| LogSize | Long | Log file size in bytes. |