hostprototype.get

描述

integer/array hostprototype.get(object parameters)

该方法允许根据给定参数检索主机原型。

T任何类型的用户都可以使用该方法。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅用户角色。

参数

(object) 定义所需输出的参数。

该方法支持以下参数。

参数	类型	说明
hostids	ID/array	只返回具有给定 ID 的主机原型。
discoveryids	ID/array	只返回属于给定 LLD 规则的主机原型。
inherited	boolean	如果设置为 `true`，则只返回从模板继承的监控项。
selectDiscoveryRule	query	返回包含主机原型所属 LLD 规则的 `discoveryRule` 属性。
selectInterfaces	query	返回包含主机原型自定义接口的 `interfaces` 属性。
selectGroupLinks	query	返回包含主机原型的组链接的 `groupLinks` 属性。
selectGroupPrototypes	query	返回包含主机原型的组原型的 `groupPrototypes` 属性。
selectMacros	query	返回包含主机原型宏的 `macros` 属性。
selectParentHost	query	返回包含主机原型所属主机的 `parentHost` 属性。
selectTags	query	返回包含主机原型标签的 `tags` 属性。
selectTemplates	query	返回包含链接到主机原型的模板的 `templates` 属性。支持 `count`.
sortfield	string/array	根据给定的属性对结果进行排序。可能的值：`hostid`, `host`, `name`, `status`.
countOutput	boolean	这些参数是所有 `get` 方法的通用参数，详见参考评注。
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

返回值

(integer/array) 返回二者之一：

一个对象数组；
如果使用了 countOutput 参数，则读取的对象数量。

示例

从 LLD 规则中检索主机原型

从 LLD 规则中检索所有主机原型、其组链接、组原型和标签。

请求：

{
           "jsonrpc": "2.0",
           "method": "hostprototype.get",
           "params": {
               "output": "extend",
               "selectInterfaces": "extend",
               "selectGroupLinks": "extend",
               "selectGroupPrototypes": "extend",
               "selectTags": "extend",
               "discoveryids": "23554"
           },
           "id": 1
       }

响应：

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10092",
                   "host": "{#HV.UUID}",
                   "name": "{#HV.UUID}",
                   "status": "0",
                   "templateid": "0",
                   "discover": "0",
                   "custom_interfaces": "1",
                   "inventory_mode": "-1",
                   "groupLinks": [
                       {
                           "group_prototypeid": "4",
                           "hostid": "10092",
                           "groupid": "7",
                           "templateid": "0"
                       }
                   ],
                   "groupPrototypes": [
                       {
                           "group_prototypeid": "7",
                           "hostid": "10092",
                           "name": "{#CLUSTER.NAME}",
                           "templateid": "0"
                       }
                   ],
                   "tags": [
                       {
                           "tag": "Datacenter",
                           "value": "{#DATACENTER.NAME}"
                       },
                       {
                           "tag": "Instance type",
                           "value": "{#INSTANCE_TYPE}"
                       }
                   ],
                   "interfaces": [
                       {
                           "main": "1",
                           "type": "2",
                           "useip": "1",
                           "ip": "127.0.0.1",
                           "dns": "",
                           "port": "161",
                           "details": {
                               "version": "2",
                               "bulk": "1",
                               "community": "{$SNMP_COMMUNITY}"
                           }
                       }
                   ]
               }
           ],
           "id": 1
       }

另见

来源

CHostPrototype::get() in ui/include/classes/api/services/CHostPrototype.php。

Documentation

hostprototype.get

描述

参数

返回值

示例

从 LLD 规则中检索主机原型

另见

来源