Query audit logs
Queries audit logs.
The new Qoder CN documentation site is now available. Content on this site may not reflect the latest product features and changes. Visit docs.qoder.cn for the latest product documentation.
Audit logs are retained for at least 180 days by default. Logs that exceed the retention period are automatically deleted. Export any log data that you need to retain for a longer period.
|
Supported editions |
Enterprise Dedicated Edition |
Service endpoints
Get the service endpoint and replace {domain} in the API request syntax with your endpoint.
Authorization
|
Product |
Resource |
Required permission |
|
organization settings |
Audit log |
Read-Only |
Request syntax
GET https://{domain}/oapi/v1/platform/organizations/{organizationId}/auditLogs
Request |
By time and organization
By member ID
|
Request headers |
|
|
The access token. See Access token for details. Example: pt-0fh3****0fbG_35af****0484. |
|
Request parameters |
|
|
actionTimeStart The start of the time range to query. The time must be in RFC3339 format, such as |
|
|
organizationId The organization ID. This ID can be obtained from the basic information page in the organization management console. For more information, see how to obtain an organizationId. |
|
|
userIds One or more member IDs, separated by commas. To obtain member IDs, call the ListUsers - Query user list API operation. |
|
|
apps A list of application |
|
|
actionTimeEnd The end of the time range to query. If this parameter is not specified, the current time is used. The time must be in RFC3339 format, such as |
|
|
perPage The number of data entries per page. The valid range is |
|
|
nextToken The token to retrieve the next page of results. |
Response parameters |
By time and organization
By member ID
|
|
action The action that was performed. |
|
|
actionTime The time when the action was performed. |
|
|
app Information about the application. name The application name. |
|
|
appId The application ID. |
|
|
detail The action details. |
|
|
id The unique ID of the audit log entry. |
|
|
ip The source IP address from which the action was initiated. |
|
|
organization Information about the organization. |
|
|
organizationId The organization ID. |
|
|
scope The scope of the audit log. |
|
|
targetId The ID of the target resource. |
|
|
targetType The type of the target resource.
|
|
|
user Information about the operator who performed the action. |
|
|
userId The operator ID. |
Response headers
|
Parameter |
Description |
Example |
|
x-next-token |
The token for the next page of results. This header is present only when more results are available. |
MT***********************BkYg== |
Error codes
For more information, see Error code center.