Zabbix Documentation 2.4

3.04.04.45.0 (current)| In development:5.2 (devel)| Unsupported:1.82.02.22.43.23.44.2Guidelines

User Tools

Site Tools

This translation is older than the original page and might be outdated. See what has changed.

Sidebar

ru:manual:api:reference_commentary

This is an old revision of the document!


Приложение 1. Справочные комментарии

Обозначение

Типы данных

Zabbix API поддерживает следующие типы данных:

Тип Описание
bool Логическое значение, принимает либо true, либо false.
flag Значение считается true, если оно указано и не равно null и false, в противном случае.
integer Целое число.
float Число с плавающей точкой.
string Текстовая строка.
text Более длинная строка текста.
timestamp Штамп времени в формате Unix.
array Упорядоченная последовательность значения, то есть, простой массив.
object Ассоциативный массив.
query Значение, которое определяет какие данные необходимо вернуть.

Может быть задано массивом имен свойств, чтобы возвращались только указанные свойства или, в том числе, одно из предопределенных значений:
extend - возвращает все свойства объекта;
count - возвращает количество полученных записей, поддерживается только некоторыми подзапросами.

Подписи к свойствам

Некоторые из свойств объектов маркируются короткими подписями, чтобы описать их поведение. Используются следующие подписи:

  • только чтение - значение этого свойства устанавливается автоматически не может быть определено или изменено клиентом;
  • константа - значение этого свойства можно устанавливать при создании объекта, но нельзя менять после.

Общие параметры "get" метода

Следующие параметры поддерживаются всеми get методами:

Параметр Тип Описание
countOutput flag Возвращает в результате количество записей вместо актуальных данных.
editable boolean Если задано равным true, возвращает только те объекты на которые у пользователя есть права на запись.

По умолчанию: false.
excludeSearch flag Возвращает результаты, которые не совпадают с заданным критерием search параметре.
filter object Возвращать только те результаты, которые в точности совпадают с заданным фильтром.

Принимает массив, где ключи являются именами свойств и значения, либо одно значение, либо массив значений соответствий.

Не работает с text полями.
limit integer Ограничение количества возвращаемых записей.
output query Свойства возвращаемых объектов.

Default: extend.
preservekeys flag Использование ID как ключей в результирующем массиве.
search object Возвращаемые результаты, которые соответствуют заданному шаблону поиска.

Принимает массив, где ключами являются имена свойств и строковые значения для поиска. Если не заданы дополнительные опции, эта опция выполнит LIKE “%…%” поиск.

Работает только с string и text полями.
searchByAny boolean Если задано равным true, возвращает результаты которые совпадают с любым из заданных критериев в filter или search параметрах вместо соответствия по всем.

По умолчанию: false.
searchWildcardsEnabled boolean Если задано равным true, включает использование “*” символом шаблона в search параметре.

По умолчанию: false.
sortfield string/array Сортировка результата по заданным свойствам. Обратитесь к отдельным описаниям get методов API для получения списка свойств, которые можно использовать при сортировке.
sortorder string/array Порядок сортировки. Если передан массив, каждое значение будет сопоставляться соответствующему свойству из sortfield параметра.

Возможные значения:
ASC - по возрастанию;
DESC - по убыванию.
startSearch flag search параметр будет сравнивать начало полей, то есть, выполнять LIKE “…%” поиск.