Organization administrators can use this operation to query audit logs.
|
Supported editions |
Enterprise Dedicated Edition |
Service endpoints
Get the service endpoint and replace {domain}
in the API request syntax with your
endpoint
.
Authorization information
Product | Resource | Required permission |
organization management | audit log | Read-only |
Request syntax
GET https://{domain}/oapi/v1/platform/auditLogsRequest | All usersBy organization IDBy applicationBy scope |
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 for the query. RFC 3339 format, such as | |
organizationId Navigate to the Basic Information page of the organization management console to obtain the organizationId. | |
userIds A comma-separated list of user IDs. Use the ListUsers - Query user list operation to obtain user IDs. | |
apps A list of application | |
scope The scope of the logs to retrieve.
| |
actionTimeEnd The end of the time range for the query. If you do not specify this parameter, the current time is used. In RFC 3339 format, such as | |
perPage The number of items per page. The valid range is | |
nextToken The token used to retrieve the next page of results. |
Response | All usersBy organization IDBy applicationBy scope |
action The action performed. | |
actionTime The time when the action occurred. | |
app Information about the application. | |
appId The ID of the application. | |
detail Details about the action. | |
id The unique ID of the audit log. | |
ip The source IP address of the action. | |
organization Information about the organization. | |
organizationId The ID of the organization. | |
scope The scope of the audit log. | |
targetId The ID of the target resource. | |
targetType The type of the target resource. Valid values:
| |
user Information about the user who performed the action. | |
userId The ID of the user who performed the action. |
Response headers
Parameter | Description | Example |
x-next-token | A token to retrieve the next page of results. | MT***********************BkYg== |
Error codes
For more information, see Error codes.