Skip to content

查询日志(团队、登录、文档、后台)

适用版本>=v7.0.2312a.20231221

接口说明:查询日志(团队、登录、文档、后台)

请求说明

请求地址配置域名+/graph+/v7/audit_logs
请求方法GET
签名方式WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名)
权限要求查询企业日志信息(应用授权) kso.audit.logs.read

请求头(Header)

名称是否必填说明
Content-Type固定为: application/json
Wps-Docs-Date取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT
Wps-Docs-Authorization计算方法参考签名说明
Authorization授权凭证,格式为: Bearer {access_token}

查询参数(Query)

名称参数类型是否必填说明
typestring日志类型,Enum: "group" "login" "file" "admin"
operator_idsArray操作用户,<= 20 items [ items [ 1 .. 20 ] characters ]
op_time_scopeArray操作时间范围. 开始时间,结束时间,= 2 items [ items [int64 ] ],时间戳,单位为秒
op_keysArray操作类型集合,可从“获取日志操作类型信息”接口的返回体中取值,默认是所有,[ 1 .. 100 ] items [ items [ 1 .. 1024 ] characters ]。
sourcestring应用来源, 默认为所有来源,Enum: "yundoc" "admin"
page_sizeint分页大小,page_size和page_token值相加最大值为10000(即最多查到前10000条数据)
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回next_page_token作为新的page_token,下次遍历可采用该page_token获取查询结果
group_idstring团队ID(仅团队类型),[ 1 .. 20 ] characters
file_namestring文件名称, 支持模糊搜索(仅文档类型),[ 1 .. 255 ] characters
drive_idsArray文件位置, 可以是个人或团队对应的drive_id(仅文档类型)[ 1 .. 100 ] items [ items [ 1 .. 20 ] characters ]

响应体(Response)

名称类型说明
codeintegercode
detailstringdetail
msgstringmsg
dataobject日志列表
next_page_tokenstring下一页分页标记,<= 1024 characters;当查询结果中next_page_token为空或无该返回值时,代表无下一页
itemsArrayArray of objects <= 1024 items
whatobject操作
detailstring操作详情
fileobject文件信息
∟file_idstring文件ID,<= 255 characters
∟file_namestring文件名称,<= 255 characters
∟file_pathstring文件位置详情,<= 1024 characters
∟file_posstring文件位置, 取的是对drive_id的描述, 如 xxx的团队, yyy的云文档,<= 255 characters
∟new_file_idstring新文件ID,<= 255 characters
groupobject团队信息
group_idstring团队ID,[ 1 .. 20 ] characters
group_namestring团队名称,[ 1 .. 255 ] characters
op_keystring操作类型
whenobject时间
op_start_timeint操作开始时间,时间戳,单位为秒
op_timeint操作结束时间,时间戳,单位为秒
whereobject地点
deviceobject设备信息
idstringID,<= 255 characters
platformstring平台类型,Enum: "ios" "web"
ip_addrstring客户端ip地址,<= 255 characters
sourcestring操作平台,日志来源,Enum: "yundoc" "admin"
whoobject
company_idstring企业ID,<= 20 characters
def_dept_abs_pathstring主部门绝对路径,<= 2048 characters
def_dept_namestring主部门名称,<= 255 characters
operator_dept_idsArray操作者所在的部门IDs,<= 100 items [ items [ 1 .. 20 ] characters ]
operator_idstring操作者ID,[ 1 .. 20 ] characters
operator_login_namestring操作者登录名,<= 255 characters
operator_user_namestring操作者姓名,<= 255 characters

响应体示例

json
{
  "data": {
    "items": [
      {
        "what": {
          "detail": "string",
          "file": {
            "file_id": "string",
            "file_name": "string",
            "file_path": "string",
            "file_pos": "string",
            "new_file_id": "string"
          },
          "group": {
            "group_id": "string",
            "group_name": "string"
          },
          "op_key": "string"
        },
        "when": {
          "op_time": 0,
          "op_start_time": 0
        },
        "where": {
          "device": {
            "id": "string",
            "platform": "ios"
          },
          "ip_addr": "string",
          "source": "yundoc"
        },
        "who": {
          "company_id": "string",
          "def_dept_abs_path": "string",
          "def_dept_name": "string",
          "operator_dept_ids": ["string"],
          "operator_id": "string",
          "operator_login_name": "string",
          "operator_user_name": "string"
        }
      }
    ],
    "next_page_token": "string"
  },
  "code": 0,
  "detail": "string",
  "msg": "string"
}