On this page
Task 对象
以下对象与 task API 直接相关。
Task
Task 对象具有以下属性：
| Property | Type | Description |
|---|---|---|
| taskid | ID | 任务的 ID。 Property behavior: - read-only |
| type | integer | 任务类型。 可能的值： 1 - 诊断信息； 2 - 刷新 proxy 配置； 6 - 立即执行。 自 Zabbix 7.0.19 起，Admin 和 User 类型用户可以创建“立即执行”任务。 请注意， task.get 始终返回 "7"（任务执行摘要）。Property behavior: - required |
| status | integer | 任务状态。 可能的值： 1 - 新任务； 2 - 任务进行中； 3 - 任务已完成； 4 - 任务已过期。 Property behavior: - read-only |
| clock | timestamp | 创建任务的时间。 Property behavior: - read-only |
| ttl | integer | 任务过期前的秒数。 Property behavior: - read-only |
| proxyid | ID | 收集诊断信息统计数据的 proxy 的 ID。 Property behavior: - supported if type is set to "Diagnostic information" or "Refresh proxy configuration" |
| request | object | 根据任务类型而定的任务请求对象： “立即执行”任务的对象详见下文； “刷新 proxy 配置”任务的对象详见下文； “诊断信息”任务的对象详见下文。 Property behavior: - required |
| result | object | 诊断信息任务的结果对象。 如果结果尚未准备好，可能为 NULL。 结果对象详见下文。 Property behavior: - read-only |
“立即执行”请求对象
“立即执行”任务请求对象具有以下属性。
| 属性 | 类型 | 描述 |
|---|---|---|
| itemid | ID | 监控项和低级别发现规则的 ID。 自 Zabbix 7.0.19 起，Admin 和 User 类型用户可以对其具有 读写 权限 的主机上的监控项执行“立即执行”，或者在其角色中启用了 invoke_execute_now 动作 的 读 权限。对于低级别发现（LLD）规则，Admin 类型用户同样适用。 |
“刷新 proxy 配置”请求对象
“刷新 proxy 配置”任务请求对象具有以下属性。
| Property | Type | Description |
|---|---|---|
| proxyids | array | Proxy ID。 |
“诊断信息”请求对象
诊断信息任务请求对象具有以下属性。所有类型属性的统计请求对象在下文中详细描述。
| Property | Type | Description |
|---|---|---|
| historycache | object | History cache 统计请求。可在服务器和 proxy 上使用。 |
| valuecache | object | 监控项缓存统计请求。可在服务器上使用。 |
| preprocessing | object | 预处理管理器统计请求。可在服务器和 proxy 上使用。 |
| alerting | object | 告警管理器统计请求。可在服务器上使用。 |
| lld | object | LLD 管理器统计请求。可在服务器上使用。 |
统计请求对象
统计请求对象用于定义应收集关于服务器/proxy 内部进程的哪类信息。它具有以下属性。
| Property | Type | Description |
|---|---|---|
| stats | query | 要返回的统计对象属性。 每种诊断信息统计类型可用字段列表的详细说明，请参见下文。 默认值： extend 将返回所有可用的统计字段。 |
| top | object | 用于对返回的统计值进行排序和限制的对象。 每种诊断信息统计类型可用字段列表的详细说明，请参见下文。 示例：{ "source.alerts": 10 } |
每种诊断信息请求可用的统计字段列表
以下统计字段可以按每种诊断信息请求属性进行请求。
| 诊断类型 | 可用字段 | 描述 |
|---|---|---|
| historycache | 监控项 | 缓存的 监控项 数量。 |
| values | 缓存值的数量。 | |
| memory | 共享 memory 统计信息（空闲空间、已使用块数量、空闲块数量、最大空闲块大小）。 | |
| memory.data | 历史数据缓存共享 memory 统计信息。 | |
| memory.index | 历史 index cache 缓存共享 memory 统计信息。 | |
| valuecache | 监控项 | 缓存的 监控项 数量。 |
| values | 缓存值的数量。 | |
| memory | 共享 memory 统计信息（空闲空间、已使用块数量、空闲块数量、最大空闲块大小）。 | |
| mode | value cache 模式。 | |
| preprocessing | values | 排队中的值数量。 |
| preproc.values | 带预处理步骤的排队值数量。 | |
| alerting | alerts | 排队中的告警数量。 |
| lld | rules | 排队中的规则数量。 |
| values | 排队中的值数量。 |
每种诊断信息请求可用的排序字段列表
以下统计字段可用于对请求的信息进行排序和限制。
| Diagnostic type | Available fields | Type |
|---|---|---|
| historycache | values | integer |
| valuecache | values | integer |
| request.values | integer | |
| preprocessing | values | integer |
| alerting | media.alerts | integer |
| source.alerts | integer | |
| lld | values | integer |
统计结果对象
统计结果对象在任务对象的 result 字段中获取。
| Property | Type | Description |
|---|---|---|
| status | integer | 任务结果的状态。 可能的值： -1 - 执行任务时发生错误； 0 - 已创建任务结果。 Property behavior: - 只读 |
| data | string/object | 根据特定诊断信息任务的统计请求对象返回的结果。 如果执行任务时发生错误，则包含错误消息字符串。 |