文档
测试

查看动作

POST
api_jsonrpc.php

请求头

参数名
类型
描述
必填
Content-Type
String
请求的 Content-Type 头部必须设置为以下值之一: application/json-rpc, application/json 或 application/jsonrequest
必填

请求参数

参数名
类型
描述
必填
jsonrpc
string
示例:2.0 API使用的JSON-RPC协议的版本; API实现JSON-RPC版本2.0;
必填
method
string
示例:action.get 调用的API方法;
必填
params
object
数据字典 请求传递参数
必填
output
string
示例:extend 定义所需输出的参数。
必填
selectOperations
string
示例:extend 属性中的返回动作操作
必填
selectRecoveryOperations
string
示例:extend 属性中的返回动作恢复操作。
必填
selectFilter
string
示例:extend 属性中的动作过滤器。
必填
filter
object
数据字典 检索条件集
必填
eventsource
number
示例:1 动作将处理的事件的类型。Possible values for trigger events: 0 - OK; 1 - problem. Possible values for discovery events: 0 - host or service up; 1 - host or service down; 2 - host or service discovered; 3 - host or service lost. Possible values for internal events: 0 - “normal” state; 1 - “unknown” or “not supported” state.
必填
auth
string
示例:038e1d7b1735c6a5436ee9eae095879e 用户认证令牌;
必填
id
number
示例:1 请求的任意标识符;
必填

响应参数

参数名
类型
描述
必填
jsonrpc
string
示例:2.0 JSON-RPC协议的版本;
必填
result
array
数据列表 方法返回的数据;
必填
actionid
string
示例:2 动作ID
必填
name
string
示例:Auto discovery. Linux servers. 动作的名称
必填
eventsource
string
示例:1 动作将处理的事件的类型。Possible values for trigger events: 0 - OK; 1 - problem. Possible values for discovery events: 0 - host or service up; 1 - host or service down; 2 - host or service discovered; 3 - host or service lost. Possible values for internal events: 0 - “normal” state; 1 - “unknown” or “not supported” state.
必填
status
string
示例:1 动作是启动还是禁用。 取值: 0 - (默认) 启用; 1 - 禁用。
必填
esc_period
string
示例:0s 升级步骤的持续时间(秒)。必须大于60秒。接受秒,时间单位后缀和用户宏。如果设置为0或0,将使用默认动作升级期。 默认: 0s.
必填
def_shortdata
string
示例: 异常消息主题。
必填
def_longdata
string
示例: 异常消息文本。
必填
recovery_msg
string
示例:0 恢复提示信息
必填
r_shortdata
string
示例: 恢复消息主题。
必填
r_longdata
string
示例: 恢复消息文本。
必填
filter
object
数据字典 检索条件
必填
evaltype
string
示例:0 操作条件评估方法。 可能的值: 0 - (默认) AND / OR; 1 - AND; 2 - OR.
必填
formula
string
示例:用于使用自定义表达式计算筛选器条件的用户定义表达式。表达式必须包含按其公式ID引用特定筛选条件的ID。表达式中使用的ID必须与筛选条件中定义的ID完全匹配:任何条件都不能保持未使用或忽略状态。
必填
conditions
array
数据列表
必填
conditiontype
string
示例:10 触发器操作的可能值: 0—主机组; 1—主机; 2-触发器; 3—触发器名称; 4-触发严重性; 6-时间段; 13-主机模板; 15-申请; 16-维护状态; 25-事件标签; 26-事件标记值。 发现操作的可能值: 7—主机IP; 8-发现的服务类型; 9-发现的服务端口; 10-发现状态; 11-正常运行时间或停机时间; 12——收到价值; 18-发现规则; 19-发现检查; 20-代理; 21-发现物体。 自动注册操作的可能值: 20-代理; 22—主机名; 24-主机元数据。 内部操作的可能值: 0—主机组; 1—主机; 13-主机模板; 15-申请; 23-事件类型。
必填
operator
string
示例:0 条件运算符。 可能值: 0-(默认值)=; 1-<>; 2-类; 3-不喜欢; 4英寸; 5->=; 6-<=; 7-不在。
必填
value
string
示例:0 要与之比较的值。
必填
value2
string
示例: 要与之比较的次要值。条件类型为26时触发操作所需的。
必填
formulaid
string
示例:B 用于从自定义表达式引用条件的任意唯一ID。只能包含大写字母。修改过滤条件时必须由用户定义ID,但在以后请求时将重新生成ID。
必填
eval_formula
string
示例:A and B and C (只读)将用于计算筛选条件的生成表达式。表达式包含按其公式ID引用特定筛选条件的ID。eval_formula的值等于具有自定义表达式的筛选器的formula的值。
必填
operations
array
数据列表 操作集合
必填
operationid
string
示例:1 操作的ID。
必填
actionid
string
示例:2 恢复操作所属操作的ID。
必填
operationtype
string
示例:6 操作类型。 触发器操作的可能值: 0—发送消息; 1-远程命令; 11-发送恢复消息。 内部操作的可能值: 0—发送消息; 11-发送恢复消息。
必填
esc_period
string
示例:0s 默认操作步骤持续时间。必须大于60秒。接受秒,带后缀的时间单位和用户宏。
必填
esc_step_from
string
示例:1 步骤开始升级。 默认: 1.
必填
esc_step_to
string
示例:1 逐步结束升级 默认: 1.
必填
evaltype
string
示例:0 操作条件评估方法。 可能的值: 0 - (默认) AND / OR; 1 - AND; 2 - OR.
必填
opconditions
array
数据列表 用于触发动作的操作条件。
必填
optemplate
array
数据列表 将主机链接到的模板。 每个对象具有以下属性: operationid - (string) 操作的 ID; templateid - (string) 模板的ID。
必填
operationid
string
示例:1 操作的 ID;
必填
templateid
string
示例:10001 模板的ID。
必填
recoveryOperations
array
数据列表 恢复操作的详细信息
必填
operationid
string
示例:585 动作操作的ID。
必填
actionid
string
示例:2 该操作所属的操作的ID
必填
operationtype
string
示例:11 操作类型。 触发器操作的可能值: 0—发送消息; 1-远程命令; 11-发送恢复消息。 内部操作的可能值: 0—发送消息; 11-发送恢复消息。
必填
evaltype
string
示例:0 过滤条件评估方法。 可能值: 0-和/或; 1-和; 2-或; 3-自定义表达式。
必填
opconditions
array
数据列表 用于触发动作的操作条件。
必填
opmessage
object
数据字典
必填
operationid
string
示例:585 动作操作的ID。
必填
default_msg
string
示例:1 是否使用默认动作消息文本和主题。 可能的值: 0 - (默认)使用操作中的数据; 1 - 使用动作中的数据。
必填
subject
string
示例:{TRIGGER.STATUS}: {TRIGGER.NAME} 操作信息主题。
必填
message
string
示例:Trigger: {TRIGGER.NAME}Trigger status: {TRIGGER.STATUS}Trigger severity: {TRIGGER.SEVERITY}Trigger URL: {TRIGGER.URL}Item values:1. {ITEM.NAME1} ({HOST.NAME1}:{ITEM.KEY1}): {ITEM.VALUE1}2. {ITEM.NAME2} ({HOST.NAME2}:{ITEM.KEY2}): {ITEM.VALUE2}3. {ITEM.NAME3} ({HOST.NAME3}:{ITEM.KEY3}): {ITEM.VALUE3}Original event ID: {EVENT.ID} 详细信息
必填
mediatypeid
string
示例:0 将用于发送消息的媒体类型的ID。
必填
id
number
示例:1 返回唯一标识
必填

说明 / 示例

请求示例 { "jsonrpc": "2.0", "method": "action.get", "params": { "output": "extend", "selectOperations": "extend", "selectRecoveryOperations": "extend", "selectFilter": "extend", "filter": { "eventsource": 1 } }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 } 返回示例 { "jsonrpc": "2.0", "result": [ { "actionid": "2", "name": "Auto discovery. Linux servers.", "eventsource": "1", "status": "1", "esc_period": "0s", "def_shortdata": "", "def_longdata": "", "recovery_msg": "0", "r_shortdata": "", "r_longdata": "", "filter": { "evaltype": "0", "formula": "", "conditions": [ { "conditiontype": "10", "operator": "0", "value": "0", "value2": "", "formulaid": "B" }, { "conditiontype": "8", "operator": "0", "value": "9", "value2": "", "formulaid": "C" }, { "conditiontype": "12", "operator": "2", "value": "Linux", "value2": "", "formulaid": "A" } ], "eval_formula": "A and B and C" }, "operations": [ { "operationid": "1", "actionid": "2", "operationtype": "6", "esc_period": "0s", "esc_step_from": "1", "esc_step_to": "1", "evaltype": "0", "opconditions": [], "optemplate": [ { "operationid": "1", "templateid": "10001" } ] }, { "operationid": "2", "actionid": "2", "operationtype": "4", "esc_period": "0s", "esc_step_from": "1", "esc_step_to": "1", "evaltype": "0", "opconditions": [], "opgroup": [ { "operationid": "2", "groupid": "2" } ] } ], "recoveryOperations": [ { "operationid": "585", "actionid": "2", "operationtype": "11", "evaltype": "0", "opconditions": [], "opmessage": { "operationid": "585", "default_msg": "1", "subject": "{TRIGGER.STATUS}: {TRIGGER.NAME}", "message": "Trigger: {TRIGGER.NAME}\r\nTrigger status: {TRIGGER.STATUS}\r\nTrigger severity: {TRIGGER.SEVERITY}\r\nTrigger URL: {TRIGGER.URL}\r\n\r\nItem values:\r\n\r\n1. {ITEM.NAME1} ({HOST.NAME1}:{ITEM.KEY1}): {ITEM.VALUE1}\r\n2. {ITEM.NAME2} ({HOST.NAME2}:{ITEM.KEY2}): {ITEM.VALUE2}\r\n3. {ITEM.NAME3} ({HOST.NAME3}:{ITEM.KEY3}): {ITEM.VALUE3}\r\n\r\nOriginal event ID: {EVENT.ID}", "mediatypeid": "0" } } ] } ], "id": 1 }