update_group_by_id

在线编辑

此命令用于更新通过标识键识别的组的配置。

此 API 在 Guardium V9.5 及更高版本中可用。

REST API 语法

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

GuardAPI 语法

update_group_by_id parameter=value

参数

参数 值类型 描述
category 字符串 更新类别。 类别是一个可选标签，用于将策略违例和组进行分组以便报告。
GroupType 字符串 更新组类型。 有关有效组类型的列表，请参阅创建组 API 的 type 参数。
id 整数 必需。 通过标识键来识别组。
tuple_parameters 字符串 必需。 有效值：
  • client_ip
  • client_host_name
  • server_ip
  • server_host_name
  • source_program
  • db_name
  • db_user
  • os_user
  • db_type
  • net_protocol
  • server_port
  • sender_ip
  • analyzed_client_ip
  • 事件
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 方式无关，可以在任何方式下使用。

示例

使用以下命令来更新标识键为 100003 的组，使其使用组类型 OBJECTS 和类别 New category：

grdapi update_group_by_desc id=100003 GroupType=OBJECTS category="New category"