Sidebar

zh:manual:api:reference:task:object

> 对象

以下对象与 任务 API直接相关。

本节描述任务对象是Zabbix 5.0.5及以后版本才支持的。 在旧的Zabbix版本中正确使用task.create,请参阅 任务.创建文档。

任务对象支持的属性如下:

属性 类型 描述
taskid 字符 (只读) 任务ID。
type
(必须)
整型 任务类型。

可以是如下值:
1 - 诊断信息;
6 - 立即检查。
status 整型 (只读) 任务状态。

可以是如下值:
1 - 任务新建;
2 - 任务进行中;
3 - 任务完成;
4 - 任务过期。
clock 时间戳 (只读) 任务创建时间。
ttl 整型 (只读) 任务过期时间(秒)。
proxy_hostid 字符 收集到的诊断信息统计的代理的ID.
不含 '立即检查' 任务。
request
(必须)
对象 任务请求对象:
'立即检查' 任务对象参照详细描述如下;
'诊断信息' 任务对象参照 详细描述如下
result 对象 (只读) 诊断信息任务的结果对象。若结果尚未完成会包含空。 结果对象 详细描述如下

'立即检查' 请求对象

'立即检查' 任务请求对象有如下属性。

属性 类型 描述
itemid 字符 监控项和低级别发现规则的ID。

'诊断信息' 请求对象

诊断信息任务请求对象支持的属性如下。 所有属性类型的统计请求对象请参阅详细描述如下

属性 类型 描述
historycache 对象 历史缓存的统计请求。 用于服务端和代理端。
valuecache 对象 监控项缓存的统计请求。 用于服务端。
preprocessing 对象 预处理管理的统计请求。 用于服务端和代理端。
alerting 对象 告警管理的统计请求。用于服务端。
lld 对象 低级别发现的统计请求。用于服务端。

统计请求对象

统计请求对象用于定义应该收集哪些类型的关于服务器/代理内部进程的信息。支持如下属性。

属性 类型 描述
stats 查询 返回的统计对象属性。 诊断信息统计类型可用的字段列表参照 详细描述如下

缺省: 所有可用统计字段会返回extend
top 对象 统计值返回的排序和限制对象。 诊断信息统计类型可用的字段列表参照 详细描述如下

例如:
{ “source.alerts”: 10 }
诊断信息请求类型可用的统计字段列表

各类型的诊断信息请求属性请求可用下列统计字段。

诊断类型 可用字段 描述
historycache items 监控项缓存数量。
values 值缓存数量。
memory 共享内存统计 (剩余空间, 使用块数, 剩余块数, 最大剩余块数)。
memory.data 共享内存缓存统计的历史数据。
memory.index 共享内存缓存统计的历史索引。
valuecache items 监控项缓存的数量。
values 值缓存数量。
memory 共享内存统计 (剩余空间, 使用块数, 剩余块数, 最大剩余块数)。
mode 缓存模式。
preprocessing values 入队值的数量。
preproc.values 带预处理步骤值的入队数量。
alerting alerts 入队告警的数量。
lld rules 入队规则的数量。
values 入队值的数量。
诊断信息请求类型可用的排序字段列表

如下统计字段可用于排序和限制请求的信息。

诊断类型 可用字段 类型
historycache values 整型
valuecache values 整型
request.values 整型
preprocessing values 整型
alerting media.alerts 整型
source.alerts 整型
lld values 整型

统计结果对象

统计结果对象由 任务对象的result字段获取。

属性 类型 描述
status 整型 (只读) 任务结果的状态。

可以是如下值:
-1 - 任务执行时产生的错误;
-0 - 任务结果已创建。
data 字符/对象 结果根据特定诊断信息任务的统计请求对象的结果。若任务执行产生错误时会包含错误信息。