>动作对象

下面是动作（action）API 相关的对象。

动作

动作对象具有以下属性。

属性类型描述
actionidstring(readonly) 动作的 ID。
esc_period
(required)		string默认操作步骤持续时间。必须大于 60 秒。接受秒，带后缀的时间单位和用户宏。
eventsource
(required)		integer(constant) 动作将处理的事件的类型。

参见 事件”源”属性 以获取支持的事件类型列表。
name
(required)		string动作的名称。
def_longdatastring异常消息文本。
def_shortdatastring异常消息主题。
r_longdatastring恢复消息文本。
r_shortdatastring恢复消息主题。
ack_longdatastring确认操作消息文本。
ack_shortdatastring确认操作消息主题。
statusinteger动作是启动还是禁用。

取值：
0 - (默认) 启用；
1 - 禁用。
pause_suppressedinteger是否在维护期间暂停升级。

可能的值：
0 - 不要暂停升级;
1 - (默认) 暂停升级。

动作操作

动作操作对象定义执行动作时执行的操作。它具有以下属性。

属性类型描述
operationidstring(readonly) 动作操作的 ID。
operationtype
(required)		integer操作类型

可能的值：
0 - 发送消息;
1 - 远程命令;
2 - 添加主机;
3 - 删除主机;
4 - 添加到主机组;
5 - 从主机组删除;
6 - 链接到模板;
7 - 取消与模板的关联;
8 - 启用主机;
9 - 禁用主机;
10 - 设置主机库存模式。
actionidstring操作所属的动作的 ID。
esc_periodstring以秒为单位的升级步骤的持续时间。必须大于 60 秒。接受秒，时间单位后缀和用户宏。如果设置为 0 或0s，则将使用默认的动作升级周期。
默认: 0s.
请注意，升级仅支持触发器和内部操作。在触发器操作中，问题恢复和更新操作不支持升级。
esc_step_frominteger启示步骤。
默认: 1.
请注意，升级仅支持触发器和内部操作。在触发器操作中，问题恢复和更新操作不支持升级。
esc_step_tointeger结束步骤。
默认: 1.
请注意，升级仅支持触发器和内部操作。在触发器操作中，问题恢复和更新操作不支持升级。
evaltypeinteger运行状态计算方法。

可能的值:
0 - (默认) AND / OR;
1 - AND;
2 - OR.
opcommandobject包含操作所运行的命令的数据。

操作命令对象是 在下面有详细描述.

远程命令操作所需的。
opcommand_grparray运行远程命令的主机组。

每个对象具有以下属性：
opcommand_grpid - (string, readonly) 对象的 ID;
operationid - (string) 操作 ID；
groupid - (string) 主机组的 ID。

如果没有设置 opcommand_hst，则需要远程命令操作。
opcommand_hstarray主机上运行远程命令。

每个对象具有以下属性：
opcommand_hstid - (string, readonly) 对象的 ID;
operationid - (string) 操作 ID;
hostid - (string) 主机 ID; 如果设置为 0，则命令将在当前主机上运行。

如果没有设置 opcommand_grp，则需要远程命令操作。
opconditionsarray用于触发动作的操作条件

操作条件对象是 下面详细描述.
opgrouparray用于添加主机的主机组。

每个对象都具有以下属性:
operationid - (string) 操作 ID;
groupid - (string) 主机组的 ID。

添加到主机组 和 从主机组中删除 操作所必需的。
opmessageobject包含有关操作发送的消息的数据的对象。

操作消息对象是 在下面有详细描述.

消息操作必需。
opmessage_grparray要发送消息的用户组。

每个对象都具有以下属性：
operationid - (string) 操作 ID;
usrgrpid - (string) 用户组的ID。

如果未设置 opmessage_usr，则消息操作必需。
opmessage_usrarray发送消息给的用户。

每个对象都具有以下属性：
operationid - (string) 操作 ID;
userid - (string) 用户的ID。

如果未设置 opmessage_grp，则消息操作必需。
optemplatearray用于将主机链接到的模板。

每个对象都具有以下属性：
operationid - (string) 操作 ID;
templateid - (string) 模板 ID.

必须有 “绑定模板” 和 “解绑模板” 操作
opinventoryobject库存模式设置主机。

每个对象都具有以下属性:
operationid - (string) 操作 ID;
inventory_mode - (string) Inventory mode.

需要有 “Set host inventory mode” 操作。

动作操作命令

操作命令对象包含有关运行操作命令的数据。

属性类型说明
operationidstring(readonly) 操作 ID.
commandstring要运行的命令。 当类型为 (0,1,2,3) 时，此项是必须的
type
(required)		integer操作命令的类型

可能的值:
0 - custom script;
1 - IPMI;
2 - SSH;
3 - Telnet;
4 - global script.
authtypeintegerSSH 命令的认证方法。

可能的值:
0 - password;
1 - public key.

Required for SSH commands.
execute_oninteger将要执行自定义脚本操作命令的目标。

可能的值:
0 - Zabbix agent;
1 - Zabbix server;
2 - Zabbix server (proxy).

自定义脚本命令所需的。
passwordstring密码验证和 telnet 命令时用于 SSH 命令的密码。
portstring用于 SSH 和 telnet 命令的端口号。
privatekeystring使用公钥认证的 SSH 命令的私钥文件的名称。

具有密钥验证的 SSH 命令所必需的。
publickeystring用于SSH公钥和公钥认证的公钥名称。

具有密钥验证的 SSH 命令所必需的。
scriptidstring用于全局脚本命令的脚本 ID。

需要全局脚本命令。
usernamestring用于登录认证的用户名

使用 SSH 和 Telnet 命令时是必须的.

动作操作消息

操作消息对象包含有关将由操作发送的消息的数据。

属性类型说明
operationidstring(readonly) 动作操作的 ID
default_msginteger是否使用默认动作消息文本和主题。

可能的值:
0 - (default) 使用操作中的消息文本和主题
1 - 使用动作中的消息文本和主题
mediatypeidstring将用于发送消息的媒体类型ID。
messagestring操作消息文本。
subjectstring操作消息主题。

动作操作条件

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

属性类型说明
opconditionidstring(readonly) 动作操作条件的 ID
conditiontype
(required)		integer条件的类型。

可能的值:
14 - event acknowledged.
value
(required)		string与之比较的值。
operationidstring(readonly) 动作操作的 ID
operatorinteger条件运算符

可能的值：
0 - (default) =.

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

条件条件名称支持的运算期望值
14Event acknowledged=件是否被确认。

可能的值:
0 - 没有确认;
1 - 已确认。

动作恢复操作

动作恢复操作对象定义将在解决问题时执行的操作。 可以对触发操作和内部操作执行恢复操作。 它具有以下属性。

属性类型描述
operationidstring(只读) 动作操作的 ID。
operationtype
(必要)		integer操作的类型

触发动作的可能值:
0 - 发送信息;
1 - 远程命令;
11 - 通知所有参与者。

内部操作的可能值:
0 - 发送信息;
11 - 通知所有参与者。
actionidstring恢复操作所属的动作的ID。
opcommandobject对象，该对象包含有关恢复操作运行的命令的数据。

操作命令对象是 described in detail above.

必要 用于远程命令操作。
opcommand_grparray运行远程命令的主机组。

每个对象具有以下属性:
opcommand_grpid - (string, 只读) 对象的 ID;
operationid - (string) 操作的 ID;
groupid - (string) 主机组的 ID。

必要 如果未设置“opcommand_hst”，则用于远程命令操作。
opcommand_hstarray主机运行远程命令。

每个对象具有以下属性:
opcommand_hstid - (string, 只读) 对象的 ID;
operationid - (string) 操作的 ID;
hostid - (string) 主机的ID；如果设置为0，则命令将在当前主机上运行。

必要 如果未设置“opcommand_grp”，则用于远程命令操作。
opmessageobject对象，该对象包含有关恢复操作发送的消息的数据。

操作消息对象是 described in detail above.

必要 用于消息操作。
opmessage_grparray发送消息的用户组。

每个对象具有以下属性:
operationid - (string) 操作的 ID;
usrgrpid - (string) 用户组的ID。

必要 如果未设置“opmessage_usr”，则用于消息操作。
opmessage_usrarray发送消息的用户。

每个对象具有以下属性:
operationid - (string) 操作的 ID;
userid - (string) 用户 ID.

必要 如果未设置“opmessage_grp”，则用于消息操作。

动作更新操作

动作更新操作对象定义将更新问题时执行操作如（评论、确认、改变严重等级、手动关闭），可以对触发动作进行更新操作，它具有以下性质。

属性类型描述
operationidstring(readonly) (只读) 动作的 ID。
operationtype
(required)		integer操作类型。

触发动作可选的值:
0 - 发送信息;
1 - 远程命令;
12 - 通知相关人.
opcommandobject该对象包含关于更新操作运行的命令的数据。

远程命令的请求操作命令查看 动作详细操作命令 。
opcommand_grparray包含运行远程命令的主机组对象的数组。

数组中的每个对象具有以下属性：
groupid - (string) 主机组的ID. \如果 opcommand_hst没有设置，执行远程命令操作的请求。
opcommand_hstarray包含运行远程命令的主机对象的数组。

数组中的每个对象具有以下属性：
hostid - (string) 主机的ID; 如果设置为0，命令在本地主机运行。

如果opcommand_grp没有设置，执行远程命令操作的请求。
opmessageobject该对象包含关于更新操作发送的消息的数据。

操作信息对象的 详细描述。
opmessage_grparray发送消息的用户组.

数组中的每个对象具有以下属性：
usrgrpid - (string) 用户ID。

如果没有设置opmessage_usr， 只send message操作请求。
忽略send update message操作.
opmessage_usrarray发送消息的用户.

数组中的每个对象具有以下属性：
userid - (string) 用户ID。

如果没有设置opmessage_usr， 只send message操作请求。
忽略send update message操作.

动作过滤

action filter 对象定义执行配置的操作必须满足的一组条件。它具有以下属性。

属性类型描述
conditions
(必要)		array用于筛选结果的筛选条件集
evaltype
(必要)		integer过滤条件评估方法。

可能值:
0 - and/or;
1 - and;
2 - or;
3 - 自定义表达式。
eval_formulastring(只读) 用户定义的表达式，用于评估具有自定义表达式的过滤器的条件。 表达式必须包含通过其formulaid引用特定过滤条件的ID。 表达式中使用的ID必须与过滤条件中定义的ID完全匹配：没有条件可以保持未使用或省略。

必要 自定义表达式过滤器。
formulastring用户定义的表达式，用于使用自定义表达式计算过滤器的条件。表达式必须包含通过其“formulaid”引用特定筛选条件的id。表达式中使用的id必须与过滤器条件中定义的id完全匹配；

动作过滤条件

动作过滤条件对象定义在运行操作动作之前必须检查的特定条件。

属性类型描述
conditionidstring(只读) 动作条件的ID。
conditiontype
(必要)		integer条件类型。

触发操作的可能值:
0 - 主机组;
1 - 主机;
2 - 触发器;
3 - 触发器名称;
4 - 触发严重程度;
6 - 时间段;
13 - 主机模板;
15 - 应用;
16 - 维护状态;
25 - 事件标签;
26 - 事件标记值.

发现操作的可能值:
7 - 主机 IP;
8 - 发现服务类型;
9 - 发现服务端口;
10 - 发现状态;
11 - 正常运行时间或停机时间;
12 - 收到的价值;
18 - 发现规则;
19 - 发现检查;
20 - proxy;
21 - 发现对象.

自动注册操作的可能值:
20 - proxy;
22 - 主机名;
24 - 主机元数据.

内部操作的可能值:
0 - 主机组;
1 - 主机;
13 - 主机模板;
15 - 应用;
23 - 事件类型.
value
(必要)		string要与之比较的值。
value2
string要与之比较的辅助值。条件类型为 26 时触发操作所必需的。
actionidstring(只读) 条件所属操作的ID.
formulaidstring用于自定义表达式引用条件的任意唯一ID。 只能包含大写字母。 用户在修改过滤条件时必须定义ID，但在以后请求时会重新生成。
operatorinteger条件运算符。

可能的值:
0 - (default) =;
1 - <>;
2 - like;
3 - not like;
4 - in;
5 - >=;
6 - <=;
7 - not in.

为了更好地理解如何使用具有各种类型表达式的过滤器, 看看例子 检索动作和创建动作方法。

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

条件条件名称支持操作期望值
0Host group=, <>主机组 ID。
1Host=, <>主机 ID。
2Trigger=, <>触发器 ID。
3Trigger namelike, not like触发器名称。
4Trigger severity=, <>, >=, <=触发严重性。 参考触发器级别属性获取支持的触发器级别列表
5Trigger value=触发值。 参考 触发器值属性获取支持的触发器值列表.
6Time periodin, not in事件被触发的时间，参考time period.
7Host IP=, <>要用逗号分隔的一个或多个IP范围。参考network discovery configuration参阅有关支持的IP范围格式的更多信息
8Discovered service type=, <>发现服务的类型。 服务类型与用于检测服务的发现检查的类型相匹配。 参考discovery check “type” property 获取支持的类型列表。
9Discovered service port=, <>一个或多个端口范围以逗号分隔。
10Discovery status=发现对象的状态。

可能的值:
0 - 主机或服务启动;
1 - 主机或服务关闭;
2 - 发现主机或服务;
3 - 主机或服务失去连接。
11Uptime or downtime duration>=, <=指示发现的对象处于当前状态的时间（秒）。
12Received values=, <>, >=, <=, like, not like执行zabbix代理、snmpv1、snmpv2或snmpv3发现检查时返回的值。
13Host template=, <>链接模板ID。
15Application=, like, not like应用程序的名称。
16Maintenance statusin, not inNo value 必要: 使用“in”运算符意味着主机必须处于维护状态，“not in”-不处于维护状态。
18Discovery rule=, <>发现规则的ID。
19Discovery check=, <>发现检查的ID。
20Proxy=, <>代理的ID。
21Discovery object=触发发现事件的对象类型。

可能值:
1 - 发现主机;
2 - 发现服务。
22Host namelike, not like主机名。
23Event type=特定内部事件。

可能值:
0 - 监控项处于“不支持”状态;
1 -监控项处于“正常”状态；
2 -LLD规则处于“不支持”状态；
3 - LLD规则处于“正常”状态；
4 - 触发器处于“未知”状态；
5 - 触发器处于“正常”状态。
24Host metadatalike, not like自动注册主机的元数据。
25Tag=, <>, like, not like事件标记。
26Tag value=, <>, like, not like事件标记值。