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 If set to true return only objects that the user has write permissions to.

Default: false.
excludeSearch flag Return results that do not match the criteria given in the search parameter.
filter object Return only those results that exactly match the given filter.

Accepts an array, where the keys are property names, and the values are either a single value or an array of values to match against.

Doesn't work for text fields.
limit integer Limit the number of records returned.
nodeids string/array Returns objects that belong to the given nodes.
output query Object properties to be returned.

Default: extend.
preservekeys flag Use IDs as keys in the resulting array.
search object Return results that match the given wildcard search.

Accepts an array, where the keys are property names, and the values are strings to search for. If no additional options are given, this will perform a LIKE “%…%” search.

Works only for string and text fields.
searchByAny boolean If set to true return results that match any of the criteria given in the filter or search parameter instead of all of them.

Default: false.
searchWildcardsEnabled boolean If set to true enables the use of “*” as a wildcard character in the search parameter.

Default: false.
sortfield string/array Sort the result by the given properties. Refer to a specific API get method description for a list of properties that can be used for sorting.
sortorder string/array Order of sorting. If an array is passed, each value will be matched to the corresponding property given in the sortfield parameter.

Possible values are:
ASC - ascending;
DESC - descending.
startSearch flag The search parameter will compare the beginning of fields, that is, perform a LIKE “…%” search instead.