update_engine_config

在线编辑

使用 update_engine_config 命令可更改检查引擎设置。

检查引擎通过使用特定的数据库协议（例如，Oracle 或 Sybase）对服务器与客户机之间的流量进行监视。 从 " 检查引擎配置 " 页面配置检查引擎。 配置检查引擎之后，您可以使用 update_engine_config 命令来更改参数。 更多信息，请参阅配置检测引擎。

此 API 在 Guardium V11.0 及更高版本中可用。

REST API 语法

此 API 可通过 PUT 方法，以 REST 服务的形式使用。 请按如下方式调用此 API：
PUT https://[Guardium hostname or IP address]:8443/restAPI/engine_config

GuardAPI 语法

update_engine_config parameter=value

参数

有关各参数的详细信息，请参阅检测引擎配置。

参数 值类型 描述
computeAverage 布尔值 启用后，将会计算所记录的每个 SQL 构造的平均响应时间。 有效值：
  • 0 (false)
  • 1 (真)
defaultAutoCommit 布尔值 由于不同数据库的各种自动落实模型，因此该值由“重放”功能用于显式地标记事务以及在每个命令之后自动落实。 启用此参数表示忽略落实和回滚。 当前支持的数据库包括 Db2®、Informix® 和 Oracle。 有效值：
  • 0 (false)
  • 1 (真)
defaultCapture 布尔值 由“重放”功能用于区分事务和捕获值，这意味着，如果有预编译语句，那么将捕获并重放所赋予的值。 如果要以预编译语句形式重放已捕获的预编译语句，请启用此参数。 有效值：
  • 0 (false)
  • 1 (真)
excludePorts 字符串 要忽略的端口的列表。 如果您知道数据库服务器正在处理非数据库协议，并且您不希望 Guardium® 浪费周期来分析非数据库流量，请将值添加到此列表。 例如，如果您知道数据库所在的主机还运行端口 80 上的 HTTP 服务器，那么可将 80 添加至已忽略端口的列表，从而确保 Guardium 不会处理这些流。 使用逗号分隔多个值，并使用连字符来指定端口包含范围。 例如：101,105,110-223
granularity 整数 日志记录单元中的分钟数。 如果在报告中请求，那么 Guardium 会汇总此粒度的请求数据。 例如，如果记录详细程度为 60，并且特定请求在给定小时内发生“n”次。 如果禁用，那么不会记录该小时内发生该命令的确切时间。 但是，如果请求已触发策略中的规则，那么实时警报可指示准确时间。 当为策略定义异常规则时，那些规则也可适用于记录单位。 例如，每小时可能要忽略 5 个登录故障，而针对第六个登录故障发出警报。 有效值：
  • 1
  • 2
  • 5 代
  • 10
  • 15
  • 30
  • 60
inspectData 布尔值 启用后，就会检查 SQL 请求所返回的数据，并更新入口和出口计数。 如果在安全策略中使用了规则，那么必须启用此参数。 有效值：
  • 0 (false)
  • 1 (真)
logExceptionSql 布尔值 如果启用，那么记录异常时将会记录完整的 SQL 语句。 有效值：
  • 0 (false)
  • 1 (真)
logRecords 布尔值 启用后，将为每个 SQL 语句记录影响的记录数（如果适用）。 有效值：
  • 0 (false)
  • 1 (真)
缺省值 = 0

“受影响记录数”选项是嗅探器操作，它要求嗅探器处理额外的响应包，并推迟受影响数据的日志记录。 这样会增加缓冲区大小，并有可能对嗅探器总体性能产生负面影响。 真正很大的响应会带来严重影响。 为避免与此操作相关联的大量开销，Guardium 使用一组缺省阈值，这些阈值允许嗅探器决定在超出阈值时跳过处理操作。

请参阅配置和控制 CLI 命令 store max_results_set_size、 store max_result_set_packet_size 和 store max_tds_response_packets ，以设置粒度级别。

对于下列各项，不支持“受影响的记录数”功能：
  • Db2（使用流式方法来发送结果时）。
  • AWS
  • Couchbase
  • Hadoop 集成
结果集值的示例：
  • 第 1 种情况：“受影响的记录数”值为正数。 这表示结果集的正确大小。
  • 第 2 种情况：“受影响的记录数”值为 -2。 这意味着记录数超过可配置限制（可以通过 CLI 命令调整此限制）。
  • 第 3 种情况：“受影响的记录数”值为 -1。 这表示包配置不受 Guardium 支持的所有情况。
  • 第 4 种情况：“受影响的记录数”值为 -2。 这表示结果集由流方式发送。
  • 第 5 种情况：“受影响的记录数”值小于 -2。 对更新用户当前值的记录进行计数期间的中间结果，以正的总记录数结尾。 例如，服务器在 4 个包中总共返回 1000 个记录：
    • 第 1 个包：250
    • 第 2 个包：200
    • 第 3 个包：250
    • 第 4 个包：200

    在这种情况下，受影响的记录数报告为：

    • 第 1 个包：-250
    • 第 2 个包：-500
    • 第 3 个包：-750
    • 第 4 个包：1000
logSequencing 布尔值 启用后，记录由前一条 SQL 语句以及当前 SQL 语句组成，前提是前一构造发生在足够短的时间段内。 有效值：
  • 0 (false)
  • 1 (真)
maxHits 整数 当检查返回的数据时，指示要记录的命中（策略规则违例）次数。
parseXml 布尔值 检查引擎通常不会解析 XML 流量。 启用即可解析 XML 流量。 有效值：
  • 0 (false)
  • 1 (真)
recordEmpty 布尔值 启用后，将记录不含任何 SQL 语句的会话。 禁用后，将会忽略这些会话。 有效值：
  • 0 (false)
  • 1 (真)
api_target_host 字符串

指定执行 API 所在的目标主机。有效值：
  • all_managed：在所有受管单元上执行，但不在中央管理器上执行
  • all：在所有受管单元和中央管理器上执行
  • group:<group name>: 在 <group name> 标识的所有受管单元上执行
  • 受管单元的主机名或 IP 地址：从中央管理器指定，以便在受管单元上执行。 例如，api_target_host=10.0.1.123。
  • 中央管理器的主机名或 IP 地址：从受管单元指定，以便在中央管理器上执行。 例如，api_target_host=10.0.1.123。

IP 地址必须符合网络的 IP 方式。 在双重 IP 方式下，请使用向中央管理器注册受管单元时使用的 IP 协议。 例如，如果该注册使用的是 IPv6，请指定 IPv6 地址。 主机名与 IP 方式无关，可以在任何方式下使用。

示例

以下 GuardAPI 示例更改三个检查引擎参数。

grdapi update_engine_config defaultCapture=true logExceptionSql=false maxHits=32

如果成功，此命令将返回以下信息：

ID=0
确定