Query Audit Logs¶

查询审计日志记录。

请求格式¶

POST https://{apigw-address}/app-portal-service/v2.2/log/query

请求参数（Query）¶

名称	必需/可选	数据类型	描述
orgId	必需	String	组织 ID。
locale	可选	String	语言。

请求参数（Body）¶

名称	必需/可选	数据类型	描述
startTime	必需	String	起始时间戳。
endTime	必需	String	截止时间戳。
pagination	可选	Pagination 请求结构体	分页参数，参见 Pagination请求结构体>> （若不提供，则默认按照每页1000条数据的格式返回第0页的数据）。

响应参数¶

名称	数据类型	描述
data	Data 结构体	审计记录信息。

Data 结构体¶

名称	数据类型	描述
pagination	pagination 结构体	分页信息。
auditLog	AuditLogEntry 结构体	审计记录。

AuditLogEntry 结构体¶

名称	数据类型	描述
eventTime	String	事件时间。
account	Account 结构体	账号信息。
resources	Resource 结构体	资源信息。
eventName	String	事件名称。
description	String	事件描述。
ipAddress	String	IP 地址。

Account 结构体¶

名称	数据类型	描述
id	String	用户 ID。
name	String	用户名。
email	String	用户邮箱。
domain	String	用户所在的域。
userType	String	用户类型。

Resource 结构体¶

名称	数据类型	描述
type	String	资源类型。
content	String	资源内容。

错误码¶

代码	描述
31400	组织ID、分页参数、起始时间戳或截止时间戳为空。

示例¶

请求示例¶

url: https://{apigw-address}/app-portal-service/v2.2/log/query?orgId=your_org_id

method:  POST

requestBody:
{
  "pagination": {
    "pageNo": 0,
    "pageSize": 2
  },
  "startTime": 1626796800000,
  "endTime": 1631980799000
}

返回示例¶

{
    "code": 0,
    "data": {
        "pagination": {
            "total": 2835,
            "limit": 2,
            "currentPage": 0
        },
        "auditLog": [
            {
                "eventTime": 1631960934544,
                "ipAddress": "your_ip_address_1",
                "resources": [
                    {
                        "type": "User",
                        "content": "user1"
                    }
                ],
                "eventName": "Log in",
                "account": {
                    "domain": "",
                    "name": "your_user_name_1",
                    "id": "your_user_id_1",
                    "userType": "OU Administrator",
                    "email": "your_user_email_1"
                }
            },
            {
                "eventTime": 1631960162863,
                "ipAddress": "your_ip_address_2",
                "resources": [
                    {
                        "type": "User",
                        "content": "user2"
                    }
                ],
                "eventName": "Log out",
                "account": {
                    "domain": "",
                    "name": "your_user_name_2,"
                    "id": "your_user_id_2",
                    "userType": "Sub-Administrator",
                    "email": "your_user_email_2"
                }
            }
        ]
    },
    "message": "OK"
}