Table of Contents
任务对象
以下objects与taskAPI直接相关.
任务
任务object具有以下属性:
| 属性 | 数据类型 | 描述 |
|---|---|---|
| taskid | ID | 任务ID. 属性行为: - 只读 |
| type | integer | 任务类型. 可能值: 1 - 诊断信息; 2 - 刷新proxy配置; 6 - 立即执行. 属性行为: - 必填 |
| status | integer | 任务状态. 可能值: 1 - 新任务; 2 - 任务进行中; 3 - 任务已完成; 4 - 任务已过期. 属性行为: - 只读 |
| clock | timestamp | 任务创建时间. 属性行为: - 只读 |
| ttl | integer | 任务过期时间(秒). 属性行为: - 只读 |
| proxyid | ID | 收集诊断信息统计的proxyID. 属性行为: - 当 type设置为"诊断信息"或"刷新proxy配置"时支持 |
| request | object | 根据任务类型的任务请求object: '立即执行'任务的object是立即检查请求-object; '刷新proxy配置'任务的object是described in detail below; '诊断信息'任务的object是诊断信息请求-object. 属性行为: - 必填 |
| result | object | 诊断信息任务的结果object. 如果结果尚未就绪可能包含NULL. 结果object是统计结果-object. 属性行为: - 只读 |
'立即执行'请求对象
'立即执行'任务请求object具有以下属性.
| 属性 | 数据类型 | 描述 |
|---|---|---|
| itemid | ID | 监控项和低级发现规则的ID. |
'刷新 proxy 配置'请求对象
'刷新proxy配置'任务请求object具有以下属性.
| 属性 | 数据类型 | 描述 |
|---|---|---|
| proxyids | array | Proxy ID. |
'诊断信息'请求对象
诊断信息任务请求object具有以下属性。所有类型属性的统计请求object是统计请求-object。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| historycache | object | history cache统计请求。可在服务器和proxy上使用。 |
| valuecache | object | 监控项缓存统计请求。可在服务器上使用。 |
| preprocessing | object | 预处理管理器统计请求。可在服务器和proxy上使用。 |
| alerting | object | 告警管理器统计请求。可在服务器上使用。 |
| lld | object | LLD管理器统计请求。可在服务器上使用。 |
统计请求对象
统计请求object用于定义应收集关于server/proxy内部进程的何种类型信息。它具有以下属性。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| stats | query | 待返回的统计object属性。 每种诊断信息统计类型的可用字段列表见每种诊断信息请求类型可用的统计字段列表。 默认值： extend将返回所有可用统计字段。 |
| top | object | 用于排序和限制返回统计值的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 | 排队值的数量 |
每种诊断信息请求可用的排序字段列表
以下统计字段可用于排序和限制请求的信息。
| 诊断类型 | 可用字段 | 数据类型 |
|---|---|---|
| historycache | values | integer |
| valuecache | values | integer |
| request.values | integer | |
| preprocessing | values | integer |
| alerting | media.alerts | integer |
| source.alerts | integer | |
| lld | values | integer |
统计结果对象
统计结果object通过任务object的result字段获取.