На странице
Объект task
Следующие объекты напрямую связаны с API task.
Task
Объект task имеет следующие свойства:
| Property | Type | Description |
|---|---|---|
| taskid | ID | ID задачи. Поведение свойства: - только для чтения |
| type | integer | Тип задачи. Возможные значения: 1 - диагностическая информация; 2 - обновление конфигурации прокси; 6 - выполнить сейчас. Начиная с Zabbix 7.4.3, пользователи типов Admin и User могут создавать задачи типа "Execute now". Обратите внимание, что task.get всегда возвращает "7" (сводка выполнения задачи).Поведение свойства: - обязательно |
| status | integer | Статус задачи. Возможные значения: 1 - новая задача; 2 - задача в процессе выполнения; 3 - задача завершена; 4 - срок действия задачи истек. Поведение свойства: - только для чтения |
| clock | timestamp | Время создания задачи. Поведение свойства: - только для чтения |
| ttl | integer | Время в секундах, по истечении которого задача становится просроченной. Поведение свойства: - только для чтения |
| proxyid | ID | ID прокси, по которому собирается статистика диагностической информации. Поведение свойства: - поддерживается, если type установлено в "Diagnostic information" или "Refresh proxy configuration" |
| request | object | Объект запроса задачи в зависимости от типа задачи: Объект задачи 'Execute now' подробно описан ниже; Объект задачи 'Refresh proxy configuration' подробно описан ниже; Объект задачи 'Diagnostic information' подробно описан ниже. Поведение свойства: - обязательно |
| result | object | Объект результата задачи диагностической информации. Может содержать NULL, если результат еще не готов. Объект результата подробно описан ниже. Поведение свойства: - только для чтения |
Объект запроса 'Execute now'
Объект запроса задачи 'Execute now' имеет следующие свойства.
| Property | Type | Description |
|---|---|---|
| itemid | ID | ID элемента данных и правил низкоуровневого обнаружения. Начиная с Zabbix 7.4.3, пользователи типов Admin и User могут выполнять 'Execute now' для элементов данных на узлах сети, для которых у них есть разрешение read-write или разрешение read и для их роли включено действие invoke_execute_now. То же самое относится к пользователям типа Admin для правил низкоуровневого обнаружения (LLD). |
Объект запроса 'Refresh proxy configuration'
Объект запроса задачи 'Refresh proxy configuration' имеет следующие свойства.
| Property | Type | Description |
|---|---|---|
| proxyids | array | Идентификаторы прокси. |
Объект запроса 'Diagnostic information'
Объект запроса задачи диагностической информации имеет следующие свойства. Объект запроса статистики для всех типов свойств подробно описан ниже.
| Property | Type | Description |
|---|---|---|
| historycache | object | Запрос статистики кэша истории. Доступно на сервере и прокси. |
| valuecache | object | Запрос статистики кэша элементов данных. Доступно на сервере. |
| preprocessing | object | Запрос статистики менеджера предварительной обработки. Доступно на сервере и прокси. |
| alerting | object | Запрос статистики менеджера оповещений. Доступно на сервере. |
| lld | object | Запрос статистики менеджера LLD. Доступно на сервере. |
Объект запроса статистики
Объект запроса статистики используется для определения того, какой тип информации следует собирать о внутренних процессах сервера/прокси. Он имеет следующие свойства.
| Property | Type | Description |
|---|---|---|
| stats | query | Свойства объекта статистики, которые нужно вернуть. Список доступных полей для каждого типа статистики диагностической информации подробно описан ниже. По умолчанию: extend вернет все доступные поля статистики. |
| top | object | Объект для сортировки и ограничения возвращаемых значений статистики. Список доступных полей для каждого типа статистики диагностической информации подробно описан ниже. Пример: { “source.alerts”: 10 } |
Список полей статистики, доступных для каждого типа запроса диагностической информации
Для каждого свойства запроса диагностической информации можно запросить следующие поля статистики.
| Diagnostic type | Available fields | Description |
|---|---|---|
| historycache | items | Количество кэшированных элементов данных. |
| values | Количество кэшированных значений. | |
| memory | Статистика общей памяти (свободное пространство, количество используемых блоков, количество свободных блоков, максимальный размер свободного блока). | |
| memory.data | Статистика общей памяти кэша исторических данных. | |
| memory.index | Статистика общей памяти кэша индекса истории. | |
| valuecache | items | Количество кэшированных элементов данных. |
| values | Количество кэшированных значений. | |
| memory | Статистика общей памяти (свободное пространство, количество используемых блоков, количество свободных блоков, максимальный размер свободного блока). | |
| mode | Режим кэша значений. | |
| 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 - результат задачи создан. Поведение свойства: - только для чтения |
| data | string/object | Результаты в соответствии с объектом запроса статистики для конкретной задачи диагностической информации. Содержит строку сообщения об ошибке, если при выполнении задачи произошла ошибка. |