Obtaining the Audit Log List

Description

This API is used to obtain an audit log list.

URI

URI format
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog?start_time={start_time}&end_time={end_time}&offset={offset}&limit={limit}
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/instances/65d3fe0c50984b35bc1a36e9b7c7de98in02/auditlog?start_time=2020-12-06T09:00:00+0800&end_time=2020-12-10T18:00:15+0800&offset=0&limit=33

**Table 1** Parameter description
Name	Type	Mandatory	Description
X-Auth-Token	String	Yes	User token obtained from IAM. For details, see Authentication.
X-Language	String	No	Language
project_id	String	Yes	Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.
instance_id	String	Yes	The instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.
node_id	String	No	The ID of the node whose audit logs are to be queried. If this parameter is not transferred, the audit logs of all nodes are queried by default. The audit logs of cluster instances are distributed on mongos nodes.
start_time	String	Yes	The start time. The format of the start time is "yyyy-mm-ddThh:mm:ssZ". T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.
end_time	String	Yes	The end time. The format of the end time is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time. The time span cannot be longer than 30 days. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.
offset	Integer	No	The index position. If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value cannot be a negative number.
limit	Integer	No	The number of records to be queried. The value ranges from 1 to 100. If this parameter is not transferred, the first 100 DB instances are queried by default.

Requests

None

Responses

Parameter description

**Table 2** Parameter description
Name	Type	Description
audit_logs	Array of objects	The audit log details. For details about audit logs, see Table 3.
total_record	Integer	The total number of records.

**Table 3** audit_logs description
Name	Type	Description
node_id	String	The node ID.
id	String	The audit log ID.
name	String	The audit log file name.
size	Long	The size of the audit log in byte.
start_time	String	The start time of the audit log. The format is "yyyy-mm-ddThh:mm:ssZ". T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.
end_time	String	The end time of the audit log. The format is "yyyy-mm-ddThh:mm:ssZ". T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

Response example

{
  "audit_logs": [
    {
      "id": "10190012aae94b38a10269b8ad025fc1no02_1607681849871",
      "name": "0a84b6e97780d3271fd0c00f2db42932_audit_log_65d3fe0c50984b35bc1a36e9b7c7de98in02_10190012aae94b38a10269b8ad025fc1no02_1607681849871",
      "size": 24735174,
      "node_id": "10190012aae94b38a10269b8ad025fc1no02",
      "start_time": "2020-12-11T18:14:49+0800",
      "end_time": "2020-12-11T18:17:25+0800"
    }
  ],
  "total_record": 1
}

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.