Obtaining Audit Logs

Function

This API is used to obtain audit logs.

Before calling an API, you need to understand the API in Authentication.

URI

URI format
GET /v3/{project_id}/instances/{instance_id}/auditlog?start_time={start_time}&end_time={end_time}&offset={offset}&limit={limit}

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Explanation: Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints: N/A Value range: N/A Default value: N/A
instance_id	Yes	Explanation: ID of the instance to be queried. Constraints: N/A Value range: N/A Default value: N/A
start_time	Yes	Explanation: Query start time. Constraints: N/A Value range: The value is in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800. Default value: N/A
end_time	Yes	Explanation: Query end time. Constraints: N/A Value range: The value is in the "yyyy-mm-ddThh:mm:ssZ" format. The end time must be later than the start time and 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. For example, in the Beijing time zone, the time zone offset is shown as +0800. Default value: N/A
offset	Yes	Explanation: Index offset. If offset is set to N, the query starts from the N+1 piece of data. The value 0 indicates that the query starts from the first piece of data. Constraints: The value must be a non-negative number. Value range: An integer greater than or equal to 0 Default value: 0
limit	Yes	Explanation: Number of records to be queried. Constraints: N/A Value range: [1, 50] Default value: N/A

Request

Request parameters
None
URI example
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/auditlog?start_time=2019-11-06T09:00:00+0800&end_time=2019-11-07T10:40:15+0800&offset=0&limit=10

Response

Normal response

**Table 2** Parameters
Parameter	Type	Description
auditlogs	Array of objects	Explanation: Indicates detailed information. For details, see Table 3.
total_record	Integer	Explanation: Indicates the total number of records. Value range: N/A

**Table 3** auditlogs field data structure description
Parameter	Type	Description
id	String	Explanation: Indicates the audit log ID. For the SQL Server engine, the ID is the audit log file name. Value range: N/A
name	String	Explanation: Indicates the audit log file name. Value range: N/A
size	Long	Explanation: Indicates the size in KB of the audit log. Value range: N/A
begin_time	String	Explanation: Indicates the start time of the audit log. Value range: The value is in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.
end_time	String	Explanation: Indicates the end time of the audit log. Value range: The value is in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.

Example normal response

{
	"auditlogs": [{
		"id": "fa163ea0e2bet11e9d832166a2cf894c5br01",
		"name": "2943db4292ee4d4abb1ae2df4870fedf_528f6b03c71c4d559ca4f60b6e20795fin01/39779175_20220825/Audit/317156_20190916032844_eb8fe5d181ec44a2850302691541f760in01_Audit_166a2cf8-d832-11e9-94c5-fa163ea0e2be",
		"size": 20481.835938,
		"begin_time": "2019-11-06T09:03:34+0800",
		"end_time": "2019-11-06T10:39:15+0800"
	}, {
		"id": "fa163ea0e2bet11e9d832136a668094c5br01",
		"name": "2943db4292ee4d4abb1ae2df4870fedf_528f6b03c71c4d559ca4f60b6e20795fin01/39779175_20220825/Audit/317162_20190916032838_eb8fe5d181ec44a2850302691541f760in01_Audit_136a6680-d832-11e9-94c5-fa163ea0e2be",
		"size": 20481.835938,
		"begin_time": "2019-11-07T09:04:35+0800",
		"end_time":"2019-11-07T10:38:16+0800"
	}],
	"total_record": 2
}