Query Audit Logs¶

查询审计日志记录。

请求格式¶

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

请求参数（URI）¶

名称

位置（Path/Query）

必需/可选

数据类型

描述

orgId

Query

必需

String

OU ID。如何获取 orgId 信息 >>

locale

Query

可选

String

指定以何种语言返回日志信息，支持以下赋值：

en_US：英语

zh_CN：中文

es_ES：西班牙语

ja_JP：日语

de_DE：德语

pl_PL：波兰语

默认返回英语 en_US 的日志信息。

请求参数（Body）¶

名称	必需/可选	数据类型	描述
startTime	必需	String	起始时间戳。
endTime	必需	String	截止时间戳。
pagination	必需	Pagination 请求结构体	分页参数。Pagination 请求参数 >>

响应参数¶

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

pagination 结构体 ¶

名称	数据类型	描述
total	Integer	总记录数。
limit	Integer	当前页的记录数。
currentPage	Integer	当前页码。

AuditLogEntry 结构体¶

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

Account 结构体¶

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

Resource 结构体¶

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

错误码¶

代码	描述
31400	OU 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"
}