ru:manual:api:reference:hostprototype:get

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Previous revision
Last revision Both sides next revision
ru:manual:api:reference:hostprototype:get [2018/06/27 06:40]
ru:manual:api:reference:hostprototype:get [2019/12/02 03:01]
127.0.0.1 external edit
Line 1: Line 1:
 +===== hostprototype.get =====
  
 +==== Описание ====
 +
 +''​целое число/​массив hostprototype.get(объект **параметры**)''​
 +
 +Этот метод позволяет получать прототипы узлов сети в соответствии с заданными параметрами.
 +
 +==== Параметры ====
 +
 +''​(объект)''​ Параметры задают желаемый вывод.
 +
 +Этот метод поддерживает следующие параметры.
 +
 +^Параметр^Тип^Описание^
 +| hostids | строка/​массив | Возврат прототипов узлов сети только с заданными ID. |
 +| discoveryids | строка/​массив | Возврат только тех прототипов узлов сети, которые принадлежат заданным LLD правилам. |
 +^ |||
 +| inherited | логический | Если задано значение ''​true'',​ возвращать только те прототипы элементов данных,​ которые унаследованы из шаблона. |
 +^ |||
 +| selectDiscoveryRule | запрос | Возврат LLD правила,​ которому принадлежит прототип узлов сети, в свойстве ''​discoveryRule''​. |
 +| selectGroupLinks | запрос | Возврат соединений с группами прототипа узлов сети в свойстве ''​groupLinks''​. |
 +| selectGroupPrototypes | запрос | Возврат прототипов групп прототипа узлов сети в свойстве ''​groupPrototypes''​. |
 +| selectInventory | логический/​массив | Возврат данных инвентаризации прототипа узлов сети в свойстве ''​inventory''​. \\ \\ Возможными значениями являются ''​true''​ для получения всех данных или массив имен свойств для получения только указанных свойств. |
 +| selectParentHost | запрос | Возврат узла сети, которому принадлежит прототип узлов сети, в свойстве ''​parentHost''​. |
 +| selectTemplates | запрос | Возврат шаблонов,​ которые соединены с прототипами узлов сети, в свойстве ''​templates''​.\\ \\ Поддерживается ''​count''​. |
 +^ |||
 +| sortfield | строка/​массив | Сортировка результата в соответствии с заданными свойствами. \\ \\ Возможные значения:​ ''​hostid'',​ ''​host'',​ ''​name''​ и ''​status''​. ​ |
 +| countOutput |логический|Эти параметры являются общими для всех методов ''​get''​ и они описаны в [[ru:​manual:​api:​reference_commentary#​общие_параметры_get_метода|справочных комментариях]]. ​ |
 +| editable |логический|:::​|
 +| excludeSearch |логический|:::​|
 +| filter | объект |:::|
 +| limit |целое число|:::​|
 +| output |запрос|:::​|
 +| preservekeys |логический|:::​|
 +| search | объект |:::|
 +| searchByAny |логический|:::​|
 +| searchWildcardsEnabled |логический|:::​|
 +| sortorder | строка/​массив | ::: |
 +| startSearch |логический|:::​|
 +
 +==== Возвращаемые значения ====
 +
 +''​(целое число/​массив)''​ Возвращает либо:
 +  * массив объектов;​
 +  * количество найденных объектов,​ если используется параметр ''​countOutput''​.
 +
 +==== Примеры ====
 +
 +=== Получение прототипов узлов сети с LLD правила ===
 +
 +Получение всех прототипов узлов сети и их соединий с группами и прототипы групп с LLD правила.
 +
 +Запрос:​
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​method":​ "​hostprototype.get",​
 +    "​params":​ {
 +        "​output":​ "​extend",​
 +        "​selectGroupLinks":​ "​extend",​
 +        "​selectGroupPrototypes":​ "​extend",​
 +        "​discoveryids":​ "​23554"​
 +    },
 +    "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +Ответ:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​result":​ [
 +        {
 +            "​hostid":​ "​10092",​
 +            "​host":​ "​{#​HV.UUID}",​
 +            "​status":​ "​0",​
 +            "​name":​ "​{#​HV.NAME}",​
 +            "​templateid":​ "​0",​
 +            "​tls_connect":​ "​1",​
 +            "​tls_accept":​ "​1",​
 +            "​tls_issuer":​ "",​
 +            "​tls_subject":​ "",​
 +            "​tls_psk_identity":​ "",​
 +            "​tls_psk":​ "",​
 +            "​groupLinks":​ [
 +                {
 +                    "​group_prototypeid":​ "​4",​
 +                    "​hostid":​ "​10092",​
 +                    "​groupid":​ "​7",​
 +                    "​templateid":​ "​0"​
 +                }
 +            ],
 +            "​groupPrototypes":​ [
 +                {
 +                    "​group_prototypeid":​ "​7",​
 +                    "​hostid":​ "​10092",​
 +                    "​name":​ "​{#​CLUSTER.NAME}",​
 +                    "​templateid":​ "​0"​
 +                }
 +            ]
 +        }
 +    ],
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +==== Смотрите также ====
 +
 +  * [[object#​соединение_с_группой|Соединение с группой]]
 +  * [[object#​прототип_группы|Прототип группы]]
 +  * [[object#​данные_инвентаризации_прототипа_узлов_сети|Данные инвентаризации прототипа узлов сети]]
 +==== Исходный код ====
 +
 +CHostPrototype::​get() в //​frontends/​php/​include/​classes/​api/​services/​CHostPrototype.php//​.