通过 API 访问审计数据
简介¶
审计日志可由经过特别授权和培训的用户访问,包括通过按照 OData v4.0 标准开发的 API(RESTful API)访问。 默认情况下,元素按 dateTimeUtc 属性降序排列,从最近到最早。
注意 该服务最多返回 10,000 个条目。
使用此查阅模式需要满足某些条件。
授权¶
要使用此特定 API,用户必须至少以读取模式启用 0001286 功能。
数据处理 API¶
| 状态 | SWAGGER | |
| ACTIVE | - | |
| 格式 | 根端点 | |
| OData | <api root>/audit/v1/dataprocessing |
以下为获取数据处理审计数据的 URL:
| URL | 描述 |
|---|---|
| 显示的服务 | |
| 返回以下元数据: - Scheme - EntityType - EntityContainer - EntitySet 特别是,为所有实体属性指定了数据类型,并且在发生更改的情况下,存在 additionalFields 属性 | |
| 返回应用程序所有数据处理的名称和描述。 | |
| 返回所选数据处理(ELABORATION_CODE)的所有发生记录。 |
additionalFields 属性显示数据处理期间更改的数据;它列出了一个值集合,每个值都有三个属性:
- field:显示更改数据的名称
- old_
= 编辑前的值 - new_
= 编辑后的值
返回数据的内容¶
调用第二个端点时,返回以下数据:
| 元素 | 描述 |
|---|---|
| oid | 处理代码 |
| dateTimeUtc | 执行日期和时间(格式:ISO 8601,UTC) |
| status | 数据处理结果 |
| parts | 处理步骤,如果分为多个部分(0 = 预运行) |
| user | 执行用户 |
| database | 执行数据库 |
| duration | 数据处理持续时间(毫秒) |
| client | 数据处理客户端 |
| ipClient | 发起数据处理的设备的 IP 地址 |
这些数据之后是维度参数(如果存在)及其相对值。
表和数据管理 API¶
以下为获取表和数据管理审计数据的 URL:
| URL | 描述 |
|---|---|
| 显示的服务 | |
| 返回以下元数据: - Scheme - EntityType - EntityContainer - EntitySet 特别是,指定了每个表的列的数据类型,并且在发生更改的情况下存在 additionalFields 属性。 | |
| 返回已编辑表的代码和描述。 | |
| 返回指定表(TABLE_CODE)中更改的所有发生记录 |
返回数据的内容¶
调用第二个端点时,返回以下数据:
| 元素 | 描述 |
|---|---|
| oid | 操作代码 |
| dateTimeUtc | 编辑日期和时间(格式:ISO 8601,UTC) |
| status | 编辑结果 |
| user | 执行用户 |
| database | 执行数据库 |
| duration | 数据处理持续时间(毫秒) |
| client | 数据处理客户端 |
| ipClient | 发起数据处理的设备的 IP 地址 |
| editType | 编辑类型(录入、编辑或删除) |
| factTable | 已编辑表的类型: - true = 事实表 - false = 主表 |
| key | 已编辑数据的物理键 |
如果进行了更改,这些数据之后可能是所选表每一列的 additionalFields 属性:
- field:显示更改数据的名称
- old_
= 编辑前的值 - new_
= 编辑后的值
多值属性聚合在同一行中,并以逗号分隔。
数据库登录 API¶
| 状态 | SWAGGER | |
| ACTIVE | - | |
| 格式 | 根端点 | |
| OData | <api root>/audit/v1/database |
以下为获取数据库登录审计数据的 URL:
| URL | 描述 |
|---|---|
| 显示的服务 | |
| 返回以下元数据: - Scheme - EntityType - EntityContainer - EntitySet | |
| 返回登录各数据库的列表。 |
返回数据的内容¶
调用第二个端点时,返回以下数据:
| 元素 | 描述 |
|---|---|
| oid | 操作代码 |
| dateTimeUtc | 登录日期和时间(格式:ISO 8601,UTC) |
| status | 操作结果 |
| user | 执行用户 |
| database | 执行数据库 |
| duration | 数据处理持续时间(毫秒) |
| client | 数据处理客户端 |
| ipClient | 运行数据处理的设备的 IP 地址 |
用户登录 API¶
以下为获取用户登录审计数据的 URL:
| URL | 描述 |
|---|---|
| 显示的服务 | |
| 返回以下元数据: - Scheme - EntityType - EntityContainer - EntitySet | |
| 返回用户登录的列表。 |
返回数据的内容¶
调用第二个端点时,返回以下数据:
| 元素 | 描述 |
|---|---|
| oid | 操作代码 |
| dateTimeUtc | 登录日期和时间(格式:ISO 8601,UTC) |
| status | 操作结果 |
| user | 执行用户 |
| client | 用户使用的客户端 |
| ipClient | 运行数据处理的设备的 IP 地址 |
| sessionDuration | 会话持续时间(毫秒),以注销或超时结束 |
| timedOut | 会话中断类型: - true = 会话超时 - false = 用户注销 |