查询历史事件 | OceanBase 文档中心

查询历史事件

更新时间：2023-08-10 11:45:58

功能说明

查询 OCP 的历史事件。可以通过事件类型、操作事件名、资源名、操作者ID、事件信息、事件状态、事件发生的时间段等条件查找历史事件。

调用说明

接口约束

调用者需要通过 OCP 应用服务鉴权。

调用者需要有查看历史事件权限(AUDIT VIEWER)

请求路径

GET /api/v2/audit/events

请求参数

参数	类型	必选	示例值	描述
eventType	StringArray	否	COMPUTE_HOST_MANAGEMENT,OB_CLUSTER_MANAGEMENT	见此表格下方事件类型表格。
operationEvent	StringArray	否	ADD_OB_ZONES, DELETE_OB_ZONES	见表格下方操作事件。
resourceName	String	否	my_ob_cluster	资源名，对于 OB 集群管理、备份恢复, 资源名是集群名；对于主机管理，资源名是主机ip；对于租户管理，资源名是集群名:租户名；对于 OCP 用户管理，资源名是 OCP 用户名；对于 OCP 集群管理，资源名对应的是 OCP 集群名。
operatorId	LongArray	否	1,2,3	操作者的 ID，对应 OCP 用户 ID。
eventInfo	String	否	{"clusterId":1}	事件信息，对应操作事件时的请求参数。
status	String	否	SUCCESS	事件的状态，目前支持两种，SUCCESS、FAILED。
startTime	OffsetDateTime	否	2021-09-07T19:04:42.768+08:00	事件发生时间段的开始时间。
endTime	OffsetDateTime	否	2021-09-08T19:04:42.768+08:00	事件发生时间段的结束时间。
page	Integer	否	1	分页参数，页数。
size	Integer	否	10	分页参数，每页大小。
order	String	否	startTime,desc	分页参数，排序。

事件类型

事件类型	类型描述
BACKUP_RESTORE	备份恢复
COMPUTE_HOST_MANAGEMENT	主机管理
OB_CLUSTER_MANAGEMENT	OceanBase 集群管理
OB_PROXY_CLUSTER_MANAGEMENT	OBProxy 管理
OB_TENANT_MANAGEMENT	租户管理
OCP_USER_MANAGEMENT	OCP 用户管理
OCP_CLUSTER_MANAGEMENT	OCP 集群管理

操作事件

操作事件	事件类型	操作描述
CREATE_SAMPLING_INSPECT_STRATEGY	BACKUP_RESTORE	创建巡检策略
CREATE_BACKUP_STRATEGY	BACKUP_RESTORE	创建备份策略
START_DATA_BACKUP	BACKUP_RESTORE	发起数据备份
START_RESTORE_TENANT	BACKUP_RESTORE	发起租户恢复
START_LOG_BACKUP	BACKUP_RESTORE	发起日志备份
UPDATE_HOST	COMPUTE_HOST_MANAGEMENT	修改主机信息
ADD_HOSTS	COMPUTE_HOST_MANAGEMENT	添加主机
REINSTALL_OCP_AGENT	COMPUTE_HOST_MANAGEMENT	重装 OCP Agent
RESTART_OCP_AGENT	COMPUTE_HOST_MANAGEMENT	重启 OCPA gent
STOP_OCP_AGENT	COMPUTE_HOST_MANAGEMENT	停止 OCP Agent
INSTALL_OCP_AGENT	COMPUTE_HOST_MANAGEMENT	安装 OCP Agent
DELETE_OB_SERVERS	OB_CLUSTER_MANAGEMENT	删除 OBServer 节点
PATCH_COMPACTION_SETTINGS	OB_CLUSTER_MANAGEMENT	删除 OBZones
ADD_OB_ZONES	OB_CLUSTER_MANAGEMENT	添加 OBZones
ADD_OB_ZONES	OB_CLUSTER_MANAGEMENT	添加 OBZones
REPLACE_OB_SERVER	OB_CLUSTER_MANAGEMENT	替换 OBServer 节点
DELETE_OB_SERVERS	OB_CLUSTER_MANAGEMENT	删除 OBServer 节点
RESTART_OB_SERVER	OB_CLUSTER_MANAGEMENT	重启 OBServer 节点
START_OB_SERVER	OB_CLUSTER_MANAGEMENT	启动 OBServer 节点
CREATE_OB_CLUSTER	OB_CLUSTER_MANAGEMENT	创建 OceanBase 集群
START_OB_CLUSTER	OB_CLUSTER_MANAGEMENT	启动 OceanBase 集群
STOP_OB_CLUSTER	OB_CLUSTER_MANAGEMENT	停止 OceanBase 集群
RESTART_OB_CLUSTER	OB_CLUSTER_MANAGEMENT	重启 OceanBase 集群
UPGRADE_OB_CLUSTER	OB_CLUSTER_MANAGEMENT	升级 OceanBase 集群
DELETE_OB_CLUSTER	OB_CLUSTER_MANAGEMENT	删除 OceanBase 集群
TAKE_OVER_OB_CLUSTER	OB_CLUSTER_MANAGEMENT	接管 OceanBase 集群
MOVE_OUT_OB_CLUSTER	OB_CLUSTER_MANAGEMENT	迁出 OceanBase 集群
SWITCHOVER_OB_CLUSTER	OB_CLUSTER_MANAGEMENT	日常切换
FAILOVER_OB_CLUSTER	OB_CLUSTER_MANAGEMENT	容灾切换
UPDATE_OB_CLUSTER_PARAMETERS	OB_CLUSTER_MANAGEMENT	修改 OceanBase 集群参数
CHANGE_OB_CLUSTER_PASSWORD	OB_CLUSTER_MANAGEMENT	修改 OceanBase 集群密码
ADD_OB_SERVERS	OB_CLUSTER_MANAGEMENT	添加 OBServer 节点
ADD_OB_SERVERS	OB_CLUSTER_MANAGEMENT	添加 OBServer 节点
STOP_OB_SERVER	OB_CLUSTER_MANAGEMENT	停止 OBServer 节点
RESTART_OB_PROXIES	OB_PROXY_CLUSTER_MANAGEMENT	重启 OBProxy
CHANGE_PROXY_SYS_PASSWORD	OB_PROXY_CLUSTER_MANAGEMENT	修改 proxysys 密码
PATCH_OB_PROXY_OB_LINK	OB_PROXY_CLUSTER_MANAGEMENT	修改 OBLink
CREATE_OB_PROXY_CLUSTER	OB_PROXY_CLUSTER_MANAGEMENT	创建 OBProxy 集群
DELETE_OB_PROXY_CLUSTER	OB_PROXY_CLUSTER_MANAGEMENT	删除 OBProxy 集群
UPGRADE_OB_PROXIES	OB_PROXY_CLUSTER_MANAGEMENT	升级 OBProxy
ADD_OB_PROXIES	OB_PROXY_CLUSTER_MANAGEMENT	添加 OBProxy
DELETE_OB_PROXY_OB_LINK	OB_PROXY_CLUSTER_MANAGEMENT	删除 OBLink
DELETE_OB_PROXIES	OB_PROXY_CLUSTER_MANAGEMENT	删除 OBProxy
PATCH_OB_PROXY_CLUSTER	OB_PROXY_CLUSTER_MANAGEMENT	修改 OBProxy 集群配置
MODIFY_OB_PROXY_PARAMETERS	OB_PROXY_CLUSTER_MANAGEMENT	修改 OBProxy 集群参数
ADD_OB_PROXY_OB_LINK	OB_PROXY_CLUSTER_MANAGEMENT	新增 OBLink
ADD_OB_PROXY_OB_LINK	OB_PROXY_CLUSTER_MANAGEMENT	新增 OBLink
UPDATE_DATABASE_USER	OB_TENANT_MANAGEMENT	修改数据库用户
UPDATE_DATABASE_USER	OB_TENANT_MANAGEMENT	修改数据库用户
LOCK_DATABASE_USER	OB_TENANT_MANAGEMENT	锁定数据库用户
UNLOCK_DATABASE_USER	OB_TENANT_MANAGEMENT	解锁数据库用户
CREATE_DATABASE_ROLE	OB_TENANT_MANAGEMENT	创建数据库角色
DELETE_DATABASE_ROLE	OB_TENANT_MANAGEMENT	删除数据库角色
UPDATE_DATABASE_ROLE	OB_TENANT_MANAGEMENT	修改数据库角色
UPDATE_DATABASE_ROLE	OB_TENANT_MANAGEMENT	修改数据库角色
UPDATE_DATABASE_ROLE	OB_TENANT_MANAGEMENT	修改数据库角色
UPDATE_DATABASE_ROLE	OB_TENANT_MANAGEMENT	修改数据库角色
UPDATE_DATABASE_ROLE	OB_TENANT_MANAGEMENT	修改数据库角色
UPDATE_DATABASE_ROLE	OB_TENANT_MANAGEMENT	修改数据库角色
UPDATE_DATABASE_ROLE	OB_TENANT_MANAGEMENT	修改数据库角色
UPDATE_DATABASE_ROLE	OB_TENANT_MANAGEMENT	修改数据库角色
UPDATE_DATABASE_ROLE	OB_TENANT_MANAGEMENT	修改数据库角色
MODIFY_DATABASE_PRIVILEGE	OB_TENANT_MANAGEMENT	修改数据库权限
DELETE_REPLICA	OB_TENANT_MANAGEMENT	删除副本
UPDATE_DATABASE_USER	OB_TENANT_MANAGEMENT	修改数据库用户
CREATE_TENANT	OB_TENANT_MANAGEMENT	创建租户
DELETE_TENANT	OB_TENANT_MANAGEMENT	删除租户
LOCK_TENANT	OB_TENANT_MANAGEMENT	锁定租户
UNLOCK_TENANT	OB_TENANT_MANAGEMENT	解锁租户
MODIFY_TENANT_PARAMETERS	OB_TENANT_MANAGEMENT	修改租户参数
MODIFY_TENANT_PRIMARY_ZONE	OB_TENANT_MANAGEMENT	更新租户 Primary Zone
MODIFY_TENANT_WHITE_LIST	OB_TENANT_MANAGEMENT	更新租户白名单
ADD_REPLICA	OB_TENANT_MANAGEMENT	添加副本
MODIFY_REPLICA	OB_TENANT_MANAGEMENT	修改副本
DELETE_UNIT	OB_TENANT_MANAGEMENT	删除资源单元
CREATE_DATABASE	OB_TENANT_MANAGEMENT	创建数据库
MODIFY_DATABASE	OB_TENANT_MANAGEMENT	修改数据库
CREATE_DATABASE_USER	OB_TENANT_MANAGEMENT	创建数据库用户
UPDATE_DATABASE_USER	OB_TENANT_MANAGEMENT	修改数据库用户
UPDATE_DATABASE_USER	OB_TENANT_MANAGEMENT	修改数据库用户
UPDATE_DATABASE_USER	OB_TENANT_MANAGEMENT	修改数据库用户
UPDATE_DATABASE_USER	OB_TENANT_MANAGEMENT	修改数据库用户
UPDATE_DATABASE_USER	OB_TENANT_MANAGEMENT	修改数据库用户
UPDATE_DATABASE_USER	OB_TENANT_MANAGEMENT	修改数据库用户
UPDATE_DATABASE_USER	OB_TENANT_MANAGEMENT	修改数据库用户
UPDATE_DATABASE_USER	OB_TENANT_MANAGEMENT	修改数据库用户
UPDATE_DATABASE_USER	OB_TENANT_MANAGEMENT	修改数据库用户
DELETE_DATABASE_USER	OB_TENANT_MANAGEMENT	删除数据库用户
DELETE_DATABASE	OB_TENANT_MANAGEMENT	删除数据库
CHANGE_MC_OCP_CLUSTER_CONFIG	OCP_CLUSTER_MANAGEMENT	修改 OCP 的集群参数
CREATE_USER	OCP_USER_MANAGEMENT	创建 OCP 用户
DELETE_USER	OCP_USER_MANAGEMENT	删除 OCP 用户
CREATE_ROLE	OCP_USER_MANAGEMENT	创建 OCP 角色
UPDATE_ROLE	OCP_USER_MANAGEMENT	修改 OCP 角色
DELETE_ROLE	OCP_USER_MANAGEMENT	删除 OCP 角色
UPDATE_USER	OCP_USER_MANAGEMENT	修改 OCP 用户
CHANGE_USER_PASSWORD	OCP_USER_MANAGEMENT	修改 OCP 用户密码

返回结果

参数	类型	说明
data	Object	请求的数据。
├─ contents	Array	AuditEventHistory 的数组，详细数据结构见下表。
├─ page	Object	分页信息，详情参见 page 参数详情。
successful	Boolean	请求是否成功。
timestamp	Datetime	服务端完成请求的时间戳。
duration	Integer	服务端处理请求的时间（毫秒）。
status	Integer	符合 HTTP Status 规范的编码。
traceId	String	请求的 Trace Id，用于排查问题。
server	String	响应请求的应用服务的地址。

AuditEventHistory 的数据结构

参数	类型	说明
id	Long	历史事件ID
operationEvent	String	操作类型，见上表「操作事件」
eventType	String	事件类型，见上表「事件类型」
resourceType	String	资源类型，有以下七种,COMPUTE_HOST(主机)，OB_TENANT(租户)，OB_CLUSTER(OB集群), OB_PROXY_CLUSTER(OBproxy集群)，OCP_USER(OCP用户)，OCP_ROLE(OCP角色),OCP_CLUSTER(OCP集群)
resourceId	Long	资源ID，主机ID、OB集群ID、OBProxy ID、租户ID等
resourceName	String	OB集群名、主机IP、租户名等
parentResource	String	如果有父资源的话，表示父资源名。比如租户的父资源是集群，那么当resourceName是租户名时，parentResource是集群名。
operatorName	String	操作者名，OCP用户名
operatorId	Long	操作者ID，OCP用户ID
status	String	事件状态 SUCCESS、FAILED
taskId	Long	任务ID，如果事件是一个运维任务的话，这里是运维任务的ID
executionType	String	运维任务执行类型，NEW(新任务)、RETRY（重试任务）
eventInfo	String	执行该操作时的请求参数
clientIp	String	执行该操作的客户端IP地址
startTime	OffsetDateTime	该操作的开始时间
endTime	OffsetDateTime	该操作的结束时间

page 参数详情

参数	类型	说明
totalElements	Integer	总记录数。
totalPage	Integer	总页数。
number	Integer	当前页码。
size	Integer	当前页大小。

示例

请求示例

GET /api/v2/audit/events

返回示例

{
  "data": {
    "contents": [
      {
        "clientIp": "xxx.xxx.xxx.1",
        "endTime": "2021-09-03T10:45:33+08:00",
        "eventInfo": "{\"hostId\":20}",
        "eventType": "COMPUTE_HOST_MANAGEMENT",
        "executionType": "NEW",
        "id": 112,
        "operationEvent": "RESTART_OCP_AGENT",
        "operatorId": 100,
        "operatorName": "admin",
        "resourceId": 20,
        "resourceName": "xxx.xxx.xxx.2",
        "resourceType": "COMPUTE_HOST",
        "startTime": "2021-09-03T10:45:30+08:00",
        "status": "FAILED"
      },
      {
        "clientIp": "xxx.xxx.xxx.1",
        "endTime": "2021-09-03T13:07:41+08:00",
        "eventInfo": "{\"hostId\":20}",
        "eventType": "COMPUTE_HOST_MANAGEMENT",
        "executionType": "NEW",
        "id": 113,
        "operationEvent": "RESTART_OCP_AGENT",
        "operatorId": 100,
        "operatorName": "admin",
        "resourceId": 20,
        "resourceName": "xxx.xxx.xxx.2",
        "resourceType": "COMPUTE_HOST",
        "startTime": "2021-09-03T13:07:39+08:00",
        "status": "FAILED"
      },
      {
        "clientIp": "xxx.xxx.xxx.1",
        "endTime": "2021-09-03T13:07:50+08:00",
        "eventInfo": "{\"hostId\":20}",
        "eventType": "COMPUTE_HOST_MANAGEMENT",
        "executionType": "NEW",
        "id": 114,
        "operationEvent": "RESTART_OCP_AGENT",
        "operatorId": 100,
        "operatorName": "admin",
        "resourceId": 20,
        "resourceName": "xxx.xxx.xxx.2",
        "resourceType": "COMPUTE_HOST",
        "startTime": "2021-09-03T13:07:48+08:00",
        "status": "FAILED"
      }
    ],
    "page": {
      "number": 1,
      "size": 10,
      "totalElements": 3,
      "totalPages": 1
    }
  },
  "duration": 12,
  "server": "a83ad33525",
  "status": 200,
  "successful": true,
  "timestamp": "2021-09-08T19:12:28.387+08:00",
  "traceId": "0a4a965ff3f344c3"
}