Skip to content

飞书低代码平台-查询数据变更日志列表

根据搜索/筛选条件,查询数据变更日志列表

Tip: 每次最多可查询 10,000 条数据

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/apaas/v1/applications/:namespace/audit_log/data_change_logs_list
HTTP MethodGET
接口频率限制10 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用app_engine:security.audit_log:read 获取飞书低代码平台审计日志信息

请求头

名称类型必填描述
Authorizationstringuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

路径参数

名称类型描述
namespacestring应用命名空间
示例值:"package_aa_bb"
数据校验规则
- 长度范围:030 字符

查询参数

名称类型必填描述
quick_querystring模糊查询
示例值:Intel Mac OS
数据校验规则
- 长度范围:01000 字符
page_sizestring分页大小
示例值:0
数据校验规则
- 长度范围:01000 字符
offsetstring翻页数量
示例值:0
数据校验规则
- 长度范围:01000 字符
fromstring查询时间范围:开始时间
示例值:1723691857002
数据校验规则
- 长度范围:01000 字符
tostring查询时间范围:结束时间
示例值:1724296657002
数据校验规则
- 长度范围:01000 字符
log_typestring”日志类型:10007-数据变更日志“
示例值:10007
数据校验规则
- 长度范围:01000 字符
filterstring日志查询:筛选能力
示例值{"items":[{"left":"eventName","operator":"=","right":[19001]}]}
数据校验规则
- 长度范围:01000 字符
columnsstring\[\]日志列表:选择展示行信息,例如["opTime","appName","eventName","clientIP","operator","status"]
示例值:operator
数据校验规则
- 长度范围:01000
sort_bystring查询排序字段:可选项为操作时间(opTime)
示例值:opTime
数据校验规则
- 长度范围:01000 字符
sort_orderstring查询排序:按时间从小到大使用 asc
示例值:asc
数据校验规则
- 长度范围:01000 字符
app_typestring应用类型,0为apaas类型,1为aily类型
示例值:0
数据校验规则
- 长度范围:01000 字符

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ itemsaudit_log_es_field\[\]数据变更日志查询结果列表详情信息
    └ log_idstring数据变更日志ID
    └ op_timestring操作时间
    └ log_typestring“日志类型:10007-数据变更日志”
    └ operatorlookup_with_avatar操作人
      └ idstring用户ID
      └ namestring用户名称
      └ tenant_idstring租户ID
      └ emailstring用户邮箱
    └ outsiderboolean是否为外部用户,true代表是外部用户
    └ login_typestring登录类型:11001-飞书登录;11003-账号密码登录
    └ lark_tenant_idstring飞书租户ID
    └ apaas_tenant_idstringapaas租户ID
    └ user_geostring用户地理信息
    └ client_ipstring客户端IP
    └ ip_locstringIP位置
    └ ip_providerstringIP提供商
    └ refererstring引用页面
    └ originstring源页面
    └ api_pathstring路由路径
    └ full_pathstring网关路径
    └ user_agentstring用户代理
    └ device_idstring设备ID
    └ web_device_idstringweb端设备ID
    └ terminal_typestring终端类型:13002-PC类型;13003-Web类型
    └ os_typestring系统类型:14002-window;14001-未知
    └ os_versionstring系统版本
    └ modulestring功能模块
    └ data_objectstring数据对象
    └ audit_scopestring审计域:15001-企业管理后台;15002-应用管理后 台;15003-应用开发平台
    └ tenant_idstring租户ID
    └ namespacestring应用唯一标识
    └ env_typestring环境类型:16001-沙箱环境;16003-线上环境
    └ op_typestring事件类型
    └ op_detailmap<string, string>操作详情内容
    └ op_sourcestring操作源:20001-前端;20004-openapi
    └ statusstring操作状态:18001-成功;18002-失败
    └ failed_reason_i18nmap<string, string>失败原因
    └ data_changesstring\[\]数据变化(旧值和新值)
    └ app_namemap<string, string>应用名称
    └ keyword_field_app_versionstring应用版本号
    └ keyword_field_functional_sub_modulestring审计日志事件子模块
  └ totalstring数据变更日志查询总条数

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "log_id": "7376574450886557740",
                "op_time": "1723634726874",
                "log_type": "10000",
                "operator": {
                    "id": "1768491480010814",
                    "name": "郭晋",
                    "tenant_id": "79844",
                    "email": "guojin.jim@bytedance.com"
                },
                "outsider": true,
                "login_type": "11001",
                "lark_tenant_id": "123",
                "apaas_tenant_id": "23333",
                "user_geo": "America/Chicago",
                "client_ip": "192.168.1.1",
                "ip_loc": "中国北京",
                "ip_provider": "ISP_com",
                "referer": "https://example.com/referer",
                "origin": "https://example.com/origin",
                "api_path": "/api/xxx",
                "full_path": "/api/xxx",
                "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 14_6 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
                "device_id": "device_1234",
                "web_device_id": "webDevice_1234",
                "terminal_type": "2",
                "os_type": "14002",
                "os_version": "14.6",
                "module": "17001",
                "data_object": "object_api_aaa",
                "audit_scope": "15001",
                "tenant_id": "23335",
                "namespace": "package_aacc",
                "env_type": "16003",
                "op_type": "19001",
                "op_detail": {},
                "op_source": "20001",
                "status": "18001",
                "failed_reason_i18n": {
                    "zh": "失败信息"
                },
                "data_changes": [
                    "{\"old\": \"OldData\",\"new\": \"NewData\"}"
                ],
                "app_name": {
                    "zh": "新闻资讯平台"
                },
                "keyword_field_app_version": "v1.2.3",
                "keyword_field_functional_sub_module": "223"
            }
        ],
        "total": "10"
    }
}

错误码

HTTP状态码错误码描述排查建议
4002320001param is invalid检查请求入参

内容来源:飞书开放平台 · 自动爬取整理