Zabbix Documentation 5.0

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

User Tools

Site Tools


ru:manual:api:reference_commentary

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
ru:manual:api:reference_commentary [2015/12/26 23:25]
dotneft created
ru:manual:api:reference_commentary [2019/10/07 06:35] (current)
Line 8: Line 8:
  
 ^ Тип ^ Описание ^ ^ Тип ^ Описание ^
-bool | Логическое значение,​ принимает либо ''​true'',​ либо ''​false''​. | +логический ​| Логическое значение,​ принимает либо ''​true'',​ либо ''​false''​. | 
-flag | Значение считается ''​true'',​ если оно указано и не равно ''​null''​ и ''​false'',​ в противном случае. | +флаг ​| Значение считается ''​true'',​ если оно указано и не равно ''​null''​ и ''​false'',​ в противном случае. | 
-integer ​| Целое число. | +целое число ​| Целое число. | 
-float | Число с плавающей точкой. | +дробное число ​| Число с плавающей точкой. | 
-string ​| Текстовая строка. | +строка ​| Текстовая строка. | 
-text | Более длинная строка текста. | +текст ​| Более длинная строка текста. | 
-timestamp ​| Штамп времени в формате Unix. | +штамп времени ​| Штамп времени в формате Unix. | 
-array | Упорядоченная последовательность значения,​ то есть, простой массив. | +массив ​| Упорядоченная последовательность значения,​ то есть, простой массив. | 
-object ​| Ассоциативный массив. | +объект ​| Ассоциативный массив. | 
-query | Значение,​ которое определяет какие данные необходимо вернуть. \\ \\ Может быть задано массивом имен свойств,​ чтобы возвращались только указанные свойства или, в том числе, одно из предопределенных значений:​ \\ ''​extend''​ - возвращает все свойства объекта;​ \\ ''​count''​ - возвращает количество полученных записей,​ поддерживается только некоторыми подзапросами. |+запрос ​| Значение,​ которое определяет какие данные необходимо вернуть. \\ \\ Может быть задано массивом имен свойств,​ чтобы возвращались только указанные свойства или, в том числе, одно из предопределенных значений:​ \\ ''​extend''​ - возвращает все свойства объекта;​ \\ ''​count''​ - возвращает количество полученных записей,​ поддерживается только некоторыми подзапросами. |
  
 === Подписи к свойствам === === Подписи к свойствам ===
Line 24: Line 24:
   * //​только чтение//​ - значение этого свойства устанавливается автоматически не может быть определено или изменено клиентом;​   * //​только чтение//​ - значение этого свойства устанавливается автоматически не может быть определено или изменено клиентом;​
   * //​константа//​ - значение этого свойства можно устанавливать при создании объекта,​ но нельзя менять после.   * //​константа//​ - значение этого свойства можно устанавливать при создании объекта,​ но нельзя менять после.
 +
 +==== Зарезервированное значение ID равное "​0"​ ====
 +
 +Зарезервированное значение ID %%"​0"​%% можно использовать для фильтрации элементов и удаления связанных объектов. Например,​ для удаления ссылки на прокси с узла сети, proxy_hostid необходимо задать значением 0 (%%"​proxy_hostid":​ "​0"​%%) или для фильтрации узлов сети наблюдаемых сервером,​ опция proxyids должна быть задана значением 0 (%%"​proxyids":​ "​0"​%%).
  
 ==== Общие параметры "​get"​ метода ==== ==== Общие параметры "​get"​ метода ====
Line 30: Line 34:
  
 ^  Параметр ​ ^  Тип ​ ^  Описание ​ ^  ^  Параметр ​ ^  Тип ​ ^  Описание ​ ^ 
-|countOutput ​ |flag |Возвращает в результате количество записей вместо актуальных данных. ​ | +|countOutput ​ |логический ​|Возвращает в результате количество записей вместо актуальных данных. ​ | 
-|editable | boolean ​| Если задано равным ''​true'',​ возвращает только те объекты на которые у пользователя есть права на запись. \\ \\ По умолчанию:​ ''​false''​. | +|editable | логический ​| Если задано равным ''​true'',​ возвращает только те объекты на которые у пользователя есть права на запись. \\ \\ По умолчанию:​ ''​false''​. | 
-|excludeSearch ​ |flag |Возвращает результаты,​ которые не совпадают с заданным критерием ''​search''​ параметре.|  +|excludeSearch ​ |логический ​|Возвращает результаты,​ которые не совпадают с заданным критерием ''​search''​ параметре.|  
-|filter ​ |object ​|Возвращать только те результаты,​ которые в точности совпадают с заданным фильтром.\\ \\ Принимает массив,​ где ключи являются именами свойств и значения,​ либо одно значение,​ либо массив значений соответствий. \\ \\ Не работает с ''​text''​ полями. | +|filter ​ |объект ​|Возвращать только те результаты,​ которые в точности совпадают с заданным фильтром.\\ \\ Принимает массив,​ где ключи являются именами свойств и значения,​ либо одно значение,​ либо массив значений соответствий. \\ \\ Не работает с ''​text''​ полями. | 
-|limit ​ |integer ​|Ограничение количества возвращаемых записей. ​ | +|limit ​ |целое число ​|Ограничение количества возвращаемых записей. ​ | 
-|output ​ |query |Свойства возвращаемых объектов. \\ \\ Default: ''​extend''​. ​ | +|output ​ |запрос ​|Свойства возвращаемых объектов. \\ \\ По умолчанию: ''​extend''​. ​ | 
-|preservekeys ​ |flag |Использование ID как ключей в результирующем массиве. ​ | +|preservekeys ​ |логический ​|Использование ID как ключей в результирующем массиве. ​ | 
-|search ​ |object ​|Возвращаемые результаты,​ которые соответствуют заданному шаблону поиска.\\ \\ Принимает массив,​ где ключами являются имена свойств и строковые значения для поиска. Если не заданы дополнительные опции, эта опция выполнит ''​LIKE "​%…%"''​ поиск.\\ \\ Работает только с ''​string''​ и ''​text''​ полями. | +|search ​ |объект ​|Возвращаемые результаты,​ которые соответствуют заданному шаблону поиска ​(регистрозависимый).\\ \\ Принимает массив,​ где ключами являются имена свойств и строковые значения для поиска. Если не заданы дополнительные опции, эта опция выполнит ''​LIKE "​%…%"''​ поиск.\\ \\ Работает только с ''​string''​ и ''​text''​ полями. | 
-|searchByAny ​ |boolean ​| Если задано равным ''​true'',​ возвращает результаты которые совпадают с любым из заданных критериев в ''​filter''​ или ''​search''​ параметрах вместо соответствия по всем. ​ \\ \\ По умолчанию:​ ''​false''​. ​ | +|searchByAny ​ |логический ​| Если задано равным ''​true'',​ возвращает результаты которые совпадают с любым из заданных критериев в ''​filter''​ или ''​search''​ параметрах вместо соответствия по всем. ​ \\ \\ По умолчанию:​ ''​false''​. ​ | 
-|searchWildcardsEnabled ​ |boolean ​| Если задано равным ''​true'',​ включает использование "​*"​ символом шаблона в ''​search''​ параметре. ​ \\ \\ По умолчанию:​ ''​false''​. | +|searchWildcardsEnabled ​ |логический ​| Если задано равным ''​true'',​ включает использование "​*"​ символом шаблона в ''​search''​ параметре. ​ \\ \\ По умолчанию:​ ''​false''​. | 
-|sortfield ​ |string/array |Сортировка результата по заданным свойствам. Обратитесь к отдельным описаниям get методов API для получения списка свойств,​ которые можно использовать при сортировке. | +|sortfield ​ |строка/массив ​|Сортировка результата по заданным свойствам. Обратитесь к отдельным описаниям get методов API для получения списка свойств,​ которые можно использовать при сортировке. Макросы не раскрываются до сортировки. | 
-|sortorder ​ |string/array |Порядок сортировки. Если передан массив,​ каждое значение будет сопоставляться соответствующему свойству из ''​sortfield''​ параметра.\\ \\ Возможные значения:​ \\ ''​ASC''​ - по возрастанию;​ \\ ''​DESC''​ - по убыванию. ​ | +|sortorder ​ |строка/массив ​|Порядок сортировки. Если передан массив,​ каждое значение будет сопоставляться соответствующему свойству из ''​sortfield''​ параметра.\\ \\ Возможные значения:​ \\ ''​ASC''​ - по возрастанию;​ \\ ''​DESC''​ - по убыванию. ​ | 
-|startSearch ​ |flag |''​search''​ параметр будет сравнивать начало полей, то есть, выполнять ''​LIKE "​…%"''​ поиск. ​ |+|startSearch ​ |логический ​|''​search''​ параметр будет сравнивать начало полей, то есть, выполнять ''​LIKE "​…%"''​ поиск.\\ \\ Игнорируется,​ если ''​searchWildcardsEnabled''​ задан равным ''​true''​.  |