文档首页/数据库安全服务 DBSS/API参考（联盟区域）/API说明/管理侧查询/查询用户操作日志信息
更新时间：2025-12-31 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询用户操作日志信息

功能介绍

查询用户操作日志信息

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/{instance_id}/dbss/audit/operate-log

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

instance_id

是

String

实例ID。可在查询实例列表接口的ID字段获取。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。

表3 请求Body参数

参数

是否必选

参数类型

描述

time

否

TimeRangeBean object

查询时间范围

user_name

否

String

操作日志用户名

action

否

String

动作名称

  • CREATE
  • DELETE
  • DOWNLOAD
  • UPDATE

result

否

String

执行结果

  • success
  • fail

page

否

String

页数

size

否

String

每页条数

表4 TimeRangeBean

参数

是否必选

参数类型

描述

end_time

否

String

结束时间，必须和start_time成对出现。格式必须为yyyy-MM-dd HH:mm:ss。UTC时间

start_time

否

String

开始时间，必须和end_time成对出现。格式必须为yyyy-MM-dd HH:mm:ss。UTC时间

time_range

否

String

请求查询的时间段，和start_time，end_time不能同时使用，同时传该参数优先级更高。

  • HALF_HOUR
  • HOUR
  • THREE_HOUR
  • TWELVE_HOUR
  • DAY
  • WEEK
  • MONTH

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

total_num

Integer

总数

operate_log

Array of OperateLogInfo objects

操作日志列表

表6 OperateLogInfo

参数

参数类型

描述

id

String

操作日志ID

user

String

操作日志用户名

time

String

该条记录发生的时间，格式为时间戳。

action

String

该条记录的操作类型

  • create：创建
  • update：更新
  • delete：删除
  • download: 下载

function

String

该条记录的功能类型

name

String

该条记录对应的用户操作对象

description

String

该条记录具体的描述

result

String

该条记录对应用户执行的结果

  • success: 成功
  • fail: 失败

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。

表8 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。

表10 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。

表12 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

请求示例

/v1/{project_id}/{instance_id}/dbss/audit/operate-log

{
  "time" : {
    "time_range" : "HOUR"
  },
  "page" : 1,
  "size" : 10
}

响应示例

状态码： 200

成功

{
  "total_num" : 3,
  "operate_log" : [ {
    "id" : "1LJP-HgBCwCqSg3BVuAp",
    "user" : "hby-test",
    "time" : "2021-04-22 06:40:52",
    "function" : "数据库列表",
    "action" : "删除",
    "name" : "db01 ",
    "description" : "删除审计的数据库",
    "result" : "success"
  }, {
    "id" : "07JO-HgBCwCqSg3ByOAD",
    "user" : "hby-test",
    "time" : "2021-04-22 06:40:15",
    "function" : "数据库列表",
    "action" : "更新",
    "name" : "db01 ",
    "description" : "关闭审计客户端",
    "result" : "success"
  }, {
    "id" : "ULKM93gBCwCqSg3BZeD1",
    "user" : "hby-test",
    "time" : "2021-04-22 03:07:56",
    "function" : "数据库列表",
    "action" : "创建",
    "name" : "db01",
    "description" : "创建新的数据库",
    "result" : "success"
  } ]
}

状态码： 400

请求参数错误

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

状态码： 500

服务器内部错误

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

状态码

状态码

描述

200

成功

400

请求参数错误

403

认证失败

500

服务器内部错误

错误码

请参见错误码。

父主题：管理侧查询