动作 object

以下objects与actionAPI直接相关。

动作

动作 object 具有以下属性。

属性	数据类型	描述
actionid	ID	动作的ID。属性行为: - 只读 - 对于 update 操作是必填的
esc_period	string	默认操作步骤持续时间。必须至少为 60 秒。接受秒、带后缀的时间单位或用户宏。属性行为: - 如果 `eventsource` 设置为“触发器创建的事件”、“内部事件”或“服务状态更新时创建的事件”，则支持
eventsource	integer	动作将处理的事件类型。有关支持的事件类型列表，请参阅 event `source` property。属性行为: - 常量 - 对于 create 操作是必填的
name	string	动作的名称。属性行为: - 对于 create 操作是必填的
status	integer	动作是启用还是禁用。可能的值： 0 - (默认) 启用； 1 - 禁用。
pause_symptoms	integer	如果事件是症状事件，是否暂停升级。可能的值： 0 - 不为症状问题暂停升级； 1 - (默认) 为症状问题暂停升级。属性行为: - 如果 `eventsource` 设置为“触发器创建的事件”，则支持
pause_suppressed	integer	在维护期间是否暂停升级。可能的值： 0 - 不暂停升级； 1 - (默认) 暂停升级。属性行为: - 如果 `eventsource` 设置为“触发器创建的事件”，则支持
notify_if_canceled	integer	升级被取消时是否通知。可能的值： 0 - 升级被取消时不通知； 1 - (默认) 升级被取消时通知。属性行为: - 如果 `eventsource` 设置为“触发器创建的事件”，则支持

Action 操作

动作操作 object 定义了将要执行的操作当一个动作被执行时。它具有以下属性：

属性	数据类型	描述
operationtype	integer	操作类型。可能的取值： 0 - 发送消息； 1 - 全局脚本； 2 - 添加主机； 3 - 移除主机； 4 - 添加到主机组； 5 - 从主机组移除； 6 - 关联模板； 7 - 取消关联模板； 8 - 启用主机； 9 - 禁用主机； 10 - 设置主机资产清单模式； 13 - 添加主机标签； 14 - 移除主机标签。如果 Action object 的 `eventsource` 设置为 "由触发器创建的事件" 或者 "服务状态更新时创建的事件"，可能的取值为： 0 - "发送消息"； 1 - "全局脚本"。如果 Action object 的 `eventsource` 设置为 "内部事件"，可能的取值为： 0 - "发送消息"。属性行为: - 必填
esc_period	string	告警升级步骤的持续时间（以秒为单位）。必须大于 60 秒。接受秒数、带后缀的时间单位或用户宏。如果设置为 0 或 0s，则使用默认的动作升级周期。默认值：0s。属性行为: - 如果动作 object 的 `eventsource` 设置为 "由触发器创建的事件"、"内部事件" 或 "在服务状态更新时创建的事件"，则为支持
esc_step_from	integer	用于指定升级流程的起始步骤。默认值: 1。属性行为: - 若动作 object 的 `eventsource` 设置为 "由触发器创建的事件"、"内部事件" 或 "在服务状态更新时创建的事件"，则为支持
esc_step_to	integer	步骤结束升级。默认值: 1。属性行为: - 支持如果动作 object 的 `eventsource` 设置为 "由触发器创建的事件"、"内部事件" 或 "在服务状态更新时创建的事件"
evaltype	integer	操作条件评估方法。可能的值： 0 - (默认) AND / OR； 1 - AND； 2 - OR。
opcommand	object	用于执行的全局脚本。全局脚本必须定义 `scriptid` 属性。属性行为: - 如果 `operationtype` 设置为 "global script" 则为必填
opcommand_grp	array	将主机组 run 到全局脚本上。主机组必须定义 `groupid` 属性。属性行为: - 如果 `operationtype` 设置为 "global script" 且 `opcommand_hst` 未设置，则为必填项
opcommand_hst	array	主机需要启用 run 全局脚本。该主机必须定义 `hostid` 属性。属性行为: - 如果 `operationtype` 设置为 "global script" 且 `opcommand_grp` 未设置，则为必填
opconditions	array	用于触发器动作的操作条件。操作条件 object 是 action-操作条件。
opgroup	array	要将主机添加到的主机组。主机组必须定义 `groupid` 属性。属性行为: - 如果 `operationtype` 设置为 "添加到主机组" 或 "从主机组中移除"，则此项必填。
opmessage	object	object 包含有关操作发送的消息的数据。操作消息 object 是 action-操作消息。属性行为： - 如果将 `operationtype` 设置为“send message”（发送消息），则为必填项。
opmessage_grp	array	发送消息的用户组。这些用户组必须定义 `usrgrpid` 属性。属性行为: - 如果将 `operationtype` 设置为“发送消息”且未设置 `opmessage_usr`，则此参数为必填
opmessage_usr	array	发送消息的用户。这些用户必须定义 `userid` 属性。属性行为: - 如果 `operationtype` 设置为 "send message" 且 `opmessage_grp` 未设置，则为必填
optemplate	array	要链接到主机的模板。模板必须定义 `templateid` 属性。属性行为： - 如果 `operationtype` 设置为“链接模板”或“取消链接模板”，则为必填
opinventory	object	将清单模式设置为主机。清单必须定义 `inventory_mode` 属性。属性行为： - 如果 `operationtype` 设置为“设置主机清单模式”，则为必填
optag	array	要添加或删除的主机标签。标签必须定义 `tag` 属性。 `value` 属性是可选的。属性行为: - 如果 `operationtype` 设置为 "添加主机标签" 或 "移除主机标签"，则为支持。

Action 操作消息

操作消息 object 包含有关操作将发送的消息的数据。它具有以下属性。

属性	数据类型	描述
default_msg	integer	是否使用默认的动作消息文本和主题。可能的值： 0 - 使用操作中的数据； 1 - (默认) 使用媒介类型中的数据。
mediatypeid	ID	用于发送消息的媒介类型的ID。属性行为: - 如果动作操作 object、动作恢复操作 object 或动作 update 操作 object 的 `operationtype` 设置为 "发送消息"，或者动作 update 操作 object 的 `operationtype` 设置为 "通知所有相关人员"，则为支持
message	string	操作消息的文本内容。属性行为: - 如果 `default_msg` 设置为 "使用操作中的数据"，则为支持
subject	string	操作消息的主题。属性行为: - 如果 `default_msg` 设置为 "使用操作中的数据"，则为支持

Action 操作条件

动作操作条件 object 定义了执行当前操作必须满足的条件。它具有以下属性。

属性	数据类型	描述
conditiontype	integer	条件类型。可能的值： 14 - 事件已确认。属性行为： - 必填
value	string	用于比较的值。属性行为： - 必填
operator	integer	条件运算符。可能的值： 0 - (默认) =

每个操作条件类型支持以下运算符和值。

条件	条件名称	支持的运算符	预期值
14	Event acknowledged	=	事件是否已确认。可能的值： 0 - 未确认； 1 - 已确认。

Action 恢复操作

恢复操作 object 定义了在问题解决时将执行的操作。恢复操作仅适用于触发器、内部和服务动作。它具有以下属性。

属性	数据类型	描述
operationtype	integer	操作类型。如果将Action object的`eventsource`设置为“由触发器创建的事件”或“服务状态更新时创建的事件”，可能的值为： 0 - 发送消息； 1 - 全局脚本； 11 - 通知所有相关人员。如果将Action object的`eventsource`设置为“内部事件”，可能的值为： 0 - 发送消息； 11 - 通知所有相关人员。属性行为： - 必填
opcommand	object	用于执行的全局脚本。全局脚本必须定义 `scriptid` 属性。属性行为: - 如果将 `operationtype` 设置为 "global script"，则必填
opcommand_grp	array	主机组用于通过 run 启用全局脚本。主机组必须定义 `groupid` 属性。属性行为: - 必填，如果动作 object 的 `eventsource` 设置为 "由触发器创建的事件"，且 `operationtype` 设置为 "全局脚本"，并且未设置 `opcommand_hst`
opcommand_hst	array	主机需要启用全局脚本的 run。该主机必须定义 `hostid` 属性。属性行为: - 如果动作 object 的 `eventsource` 设置为“由触发器创建的事件”，且 `operationtype` 设置为“全局脚本”，并且未设置 `opcommand_grp`，则为必填
opmessage	object	object 包含恢复操作发送的消息数据。操作消息 object 是 action-操作消息。属性行为： - 如果将 `operationtype` 设为“发送消息”，则为必填
opmessage_grp	array	发送消息的用户组。这些用户组必须定义 `usrgrpid` 属性。属性行为: - 如果将 `operationtype` 设置为“发送消息”且未设置 `opmessage_usr`，则此选项为必填
opmessage_usr	array	发送消息的用户。这些用户必须定义 `userid` 属性。属性行为: - 如果将 `operationtype` 设置为“发送消息”且未设置 `opmessage_grp`，则此选项为必填

Action 更新操作

动作 update 操作 object 定义了在问题更新时将执行的操作。（已评论、已确认、严重性已更改或已手动关闭）。更新操作仅适用于触发器和服务动作。它具有以下属性。

属性	数据类型	描述
operationtype	integer	操作类型。可能的值： 0 - 发送消息； 1 - 全局脚本； 12 - 通知所有相关人员。属性行为： - 必填
opcommand	object	用于执行的全局脚本。全局脚本必须定义 `scriptid` 属性。属性行为: - 如果将 `operationtype` 设置为 "global script"，则此项为必填
opcommand_grp	array	将主机组关联到run全局脚本上。主机组必须定义“groupid”属性。属性行为： - 如果操作object的“eventsource”设置为“由触发器创建的事件”，且“operationtype”设置为“全局脚本”，而“opcommand_hst”未设置，则此选项为必填
opcommand_hst	array	主机要在全局脚本上启用 run。该主机必须定义 `hostid` 属性。属性行为: - 如果动作 object 的 `eventsource` 设置为“由触发器创建的事件”，且 `operationtype` 设置为“全局脚本”，并且未设置 `opcommand_grp`，则为必填
opmessage	object	object 包含由 update 操作发送的消息数据。操作消息 object 是 action-操作消息。
opmessage_grp	array	发送消息的用户组。这些用户组必须定义 `usrgrpid` 属性。属性行为: - 如果 `operationtype` 设置为“发送消息”且 `opmessage_usr` 未设置，则为必填
opmessage_usr	array	发送消息的用户。这些用户必须定义 `userid` 属性。属性行为: - 如果将 `operationtype` 设置为 "send message" 且未设置 `opmessage_grp`，则此选项为必填

操作过滤器

动作过滤器 object 定义了一组必须满足的条件，以执行配置的动作操作。它具有以下属性。

属性	数据类型	说明
conditions	array	用于过滤结果的一组过滤条件。条件将按照它们在公式中的排列顺序进行排序。属性行为: - 必填
evaltype	integer	过滤条件评估方法。可能的值： 0 - 与/或； 1 - 与； 2 - 或； 3 - 自定义表达式。属性行为: - 必填
eval_formula	string	用于评估过滤条件的生成表达式。该表达式包含通过 `formulaid` 引用特定过滤条件的ID。对于使用自定义表达式的过滤器，`eval_formula` 的值等于 `formula` 的值。属性行为: - 只读
formula	string	用于评估使用自定义表达式的过滤器条件的用户定义表达式。该表达式必须包含通过 `formulaid` 引用特定过滤条件的ID。表达式中使用的ID必须与过滤条件中定义的ID完全匹配：不能有未使用或遗漏的条件。属性行为: - 如果 `evaltype` 设置为 "custom expression"，则必填

Action 过滤条件

动作过滤条件 object 定义了在执行动作操作前必须检查的特定条件。

属性	数据类型	描述
conditiontype	integer	条件类型。如果 Action object 的 `eventsource` 设置为 "event created by a trigger"，可能的取值如下： 0 - 主机组； 1 - 主机； 2 - 触发器； 3 - 事件名称； 4 - 触发器严重性； 6 - 时间段； 13 - 主机模板； 16 - 问题被抑制； 25 - 事件标签； 26 - 事件标签值。如果 Action object 的 `eventsource` 设置为 "event created by a discovery rule"，可能的取值如下： 7 - 主机 IP； 8 - 发现的服务类型； 9 - 发现的服务端口； 10 - 发现状态； 11 - 上线或离线时长； 12 - 接收到的值； 18 - 发现规则； 19 - 发现检查； 20 - proxy； 21 - 发现 object。如果 Action object 的 `eventsource` 设置为 "event created by active agent autoregistration"，可能的取值如下： 20 - proxy； 22 - 主机名； 24 - 主机元数据。如果 Action object 的 `eventsource` 设置为 "internal event"，可能的取值如下： 0 - 主机组； 1 - 主机； 13 - 主机模板； 23 - 事件类型； 25 - 事件标签； 26 - 事件标签值。如果 Action object 的 `eventsource` 设置为 "event created on service status update"，可能的取值如下： 25 - 事件标签； 26 - 事件标签值； 27 - 服务； 28 - 服务名称。属性行为： - 必填
value	string	用于比较的值。属性行为： - 必填
value2	string	用于二次比较的值。属性行为： - 如果 Action object 的 `eventsource` 设置为 "event created by a trigger"，且 `conditiontype` 设置为触发器动作的任意可能值，并且条件类型（见下文）为 "26"，则为必填 - 如果 Action object 的 `eventsource` 设置为 "internal event"，且 `conditiontype` 设置为内部动作的任意可能值，并且条件类型（见下文）为 "26"，则为必填 - 如果 Action object 的 `eventsource` 设置为 "event created on service status update"，且 `conditiontype` 设置为服务动作的任意可能值，并且条件类型（见下文）为 "26"，则为必填
formulaid	string	用于在自定义表达式中引用条件的任意唯一ID。只能包含大写字母。该ID必须由用户在修改过滤条件时定义，但在后续请求时将重新生成。
operator	integer	条件运算符。可能的取值： 0 - (默认) 等于； 1 - 不等于； 2 - 包含； 3 - 不包含； 4 - 在集合中； 5 - 大于等于； 6 - 小于等于； 7 - 不在集合中； 8 - 匹配； 9 - 不匹配； 10 - 是； 11 - 否。

要更好地理解如何在各种表达式中使用过滤器，请参阅检索发现动作和使用自定义表达式过滤器方法页面。

每种条件类型支持以下运算符和值。

条件	条件名称	支持的运算符	预期值
0	Host group	equals, does not equal	主机组 ID。
1	Host	equals, does not equal	主机 ID。
2	Trigger	equals, does not equal	触发器 ID。
3	Event name	contains, does not contain	事件名称。
4	Trigger severity	equals, does not equal, is greater than or equals, is less than or equals	触发器严重性。请参阅 trigger `severity` property 获取支持的触发器严重性列表。
5	Trigger value	equals	触发器值。请参阅 trigger `value` property 获取支持的触发器值列表。
6	Time period	in, not in	事件触发时间，格式为 time period。
7	Host IP	equals, does not equal	一个或多个要检查的IP范围，用逗号分隔。有关支持的IP范围格式的更多信息，请参阅 network discovery configuration 章节。
8	Discovered service type	equals, does not equal	发现的服务类型。服务类型与用于检测该服务的发现检查类型匹配。请参阅 discovery check `type` property 获取支持的类型列表。
9	Discovered service port	equals, does not equal	一个或多个端口范围，用逗号分隔。
10	Discovery status	equals	发现的 object 的状态。可能的取值： 0 - 主机或服务上线； 1 - 主机或服务离线； 2 - 主机或服务被发现； 3 - 主机或服务丢失。
11	Uptime or downtime duration	is greater than or equals, is less than or equals	表示发现的 object 处于当前状态的时长（以秒为单位）。
12	Received values	equals, does not equal, is greater than or equals, is less than or equals, contains, does not contain	执行 Zabbix agent、SNMPv1、SNMPv2 或 SNMPv3 发现检查时返回的值。
13	Host template	equals, does not equal	关联模板 ID。
16	Problem is suppressed	Yes, No	无需值：使用 "Yes" 运算符表示问题必须被抑制，"No" 表示未被抑制。
18	Discovery rule	equals, does not equal	发现规则 ID。
19	Discovery check	equals, does not equal	发现检查 ID。
20	Proxy	equals, does not equal	proxy ID。
21	Discovery object	equals	触发发现事件的 object 类型。可能的取值： 1 - 发现的主机； 2 - 发现的服务。
22	Host name	contains, does not contain, matches, does not match	主机名。在自动注册条件中，运算符 matches 和 does not match 支持使用正则表达式。
23	Event type	equals	特定的内部事件。可能的取值： 0 - 监控项处于 "not supported" 状态； 1 - 监控项处于 "normal" 状态； 2 - LLD 规则处于 "not supported" 状态； 3 - LLD 规则处于 "normal" 状态； 4 - 触发器处于 "unknown" 状态； 5 - 触发器处于 "normal" 状态。
24	Host metadata	contains, does not contain, matches, does not match	自动注册的主机元数据。运算符 matches 和 does not match 支持使用正则表达式。
25	Tag	equals, does not equal, contains, does not contain	事件标签。
26	Tag value	equals, does not equal, contains, does not contain	事件标签值。
27	Service	equals, does not equal	服务 ID。
28	Service name	equals, does not equal	服务名称。

Documentation