On this page
任务对象
以下对象与 task API 直接相关。
任务
任务对象具有以下属性:
| 属性 | 类型 | 描述 |
|---|---|---|
| taskid | ID | 任务的 ID。 属性行为: - 只读 |
| type | integer | 任务类型。 可能的值: 1 - 诊断信息; 2 - 刷新 proxy 配置; 6 - 立即执行。 Admin 和 User 类型的用户只能创建“立即执行”任务。 请注意, task.get 始终返回“7”(任务执行摘要)。属性行为: - 必需 |
| status | integer | 任务状态。 可能的值: 1 - 新任务; 2 - 任务进行中; 3 - 任务已完成; 4 - 任务已过期。 属性行为: - 只读 |
| clock | timestamp | 任务创建时间。 属性行为: - 只读 |
| ttl | integer | 任务过期前的时间(以秒为单位)。 属性行为: - 只读 |
| proxyid | ID | 收集其诊断信息统计数据的 proxy 的 ID。 属性行为: - 当 type 设置为“诊断信息”或“刷新 proxy 配置”时,支持 |
| request | object | 根据任务类型对应的任务请求对象: “立即执行”任务的对象如下详细描述; “刷新 proxy 配置”任务的对象如下详细描述; “诊断信息”任务的对象如下详细描述。 属性行为: - 必需 |
| result | object | 诊断信息任务的结果对象。 如果结果尚未就绪,则可能包含 NULL。 结果对象如下详细描述。 属性行为: - 只读 |
“立即执行”请求对象
“立即执行”任务请求对象具有以下属性。
| 属性 | 类型 | 描述 |
|---|---|---|
| itemid | ID | 监控项和低级别发现规则的 ID。 Admin 和 User 类型的用户可对其具有 读写 权限 的主机上的监控项执行“立即执行”;如果其角色启用了 invoke_execute_now 操作,则具有 只读 权限的用户也可执行“立即执行”。对于低级别发现(LLD)规则,Admin 类型用户同样适用。 |
“刷新 proxy 配置”请求对象
“刷新 proxy 配置”任务请求对象具有以下属性。
| 属性 | Type | 说明 |
|---|---|---|
| proxyids | array | Proxy ID。 |
“诊断信息”请求对象
诊断信息任务请求对象具有以下属性。所有类型属性的统计请求对象已在下文详细说明。
| 属性 | 类型 | 描述 |
|---|---|---|
| historycache | object | 历史缓存统计请求。在服务器和 proxy 上可用。 |
| valuecache | object | 监控项缓存统计请求。在服务器上可用。 |
| preprocessing | object | 预处理管理器统计请求。在服务器和 proxy 上可用。 |
| alerting | object | 告警管理器统计请求。在服务器上可用。 |
| lld | object | LLD 管理器统计请求。在服务器上可用。 |
统计信息请求对象
统计信息请求对象用于定义应收集有关服务器/proxy 内部进程的哪种类型的信息。它具有以下属性。
| 属性 | 类型 | 说明 |
|---|---|---|
| stats | query | 要返回的统计信息对象属性。 每种诊断信息统计类型的可用字段列表如下文详细说明。 默认值: extend 将返回所有可用的统计信息字段。 |
| top | object | 用于对返回的统计信息值进行排序和限制的对象。 每种诊断信息统计类型的可用字段列表如下文详细说明。 示例:{ “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 | integer |
| valuecache | values | integer |
| request.values | integer | |
| preprocessing | values | integer |
| alerting | media.alerts | integer |
| source.alerts | integer | |
| lld | values | integer |
统计结果对象
统计结果对象可在任务对象的 result 字段中获取。