Объект task

Следующие объекты напрямую связаны с API task.

Task

Объект task имеет следующие свойства:

Свойство Тип Описание
taskid ID ID задачи.

Поведение свойства:
- только для чтения
type integer Тип задачи.

Возможные значения:
1 - Диагностическая информация;
2 - Обновить конфигурацию прокси;
6 - Выполнить сейчас.

Пользователи типа Admin и User могут создавать только задачи «Выполнить сейчас».

Обратите внимание, что task.get всегда возвращает "7" (Сводка выполнения задачи).

Поведение свойства:
- обязательно
status integer Статус задачи.

Возможные значения:
1 - новая задача;
2 - задача в процессе выполнения;
3 - задача завершена;
4 - срок действия задачи истёк.

Поведение свойства:
- только для чтения
clock timestamp Время создания задачи.

Поведение свойства:
- только для чтения
ttl integer Время в секундах, по истечении которого срок действия задачи истекает.

Поведение свойства:
- только для чтения
proxyid ID ID прокси, по которому собирается статистика диагностической информации.

Поведение свойства:
- поддерживается, если type установлен в "Diagnostic information" или "Refresh proxy configuration"
request object Объект запроса задачи в соответствии с типом задачи:
Объект задачи «Выполнить сейчас» подробно описан ниже;
Объект задачи «Обновить конфигурацию прокси» подробно описан ниже;
Объект задачи «Диагностическая информация» подробно описан ниже.

Поведение свойства:
- обязательно
result object Объект результата задачи диагностической информации.
Может содержать NULL, если результат ещё не готов.
Объект результата подробно описан ниже.

Поведение свойства:
- только для чтения

Объект запроса 'Выполнить сейчас'

Объект запроса задачи 'Выполнить сейчас' имеет следующие свойства.

Свойство Тип Описание
itemid ID ID элемента данных и правил обнаружения низкого уровня.

Пользователи типа Admin и User могут выполнять действие 'Выполнить сейчас' для элементов данных на узлах сети, для которых у них есть разрешение чтение-запись или разрешение чтение и для их роли включено действие invoke_execute_now. То же самое относится к пользователям типа Admin для правил обнаружения низкого уровня (LLD).

Объект запроса 'Refresh proxy configuration'

Объект запроса задачи 'Refresh proxy configuration' имеет следующие свойства.

Свойство Тип Описание
proxyids array ID прокси.

Объект запроса 'Diagnostic information'

Объект запроса задачи диагностической информации имеет следующие свойства. Объект запроса статистики для всех типов свойств подробно описан ниже.

Свойство Тип Описание
historycache object Запрос статистики кэша истории. Доступно на сервере и прокси.
valuecache object Запрос статистики кэша элементов данных. Доступно на сервере.
preprocessing object Запрос статистики менеджера предобработки. Доступно на сервере и прокси.
alerting object Запрос статистики менеджера оповещений. Доступно на сервере.
lld object Запрос статистики менеджера LLD. Доступно на сервере.
Объект запроса статистики

Объект запроса статистики используется для определения того, какой тип информации следует собирать о внутренних процессах сервера/прокси. Он имеет следующие свойства.

Свойство Тип Описание
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 объекта задачи.

Свойство Type Описание
status integer Статус результата задачи.

Возможные значения:
-1 - во время выполнения задачи произошла ошибка;
0 - результат задачи создан.

Поведение свойства:
- только для чтения
data string/object Результаты в соответствии с объектом запроса статистики для конкретной задачи диагностической информации.
Содержит строку сообщения об ошибке, если во время выполнения задачи произошла ошибка.