4.应用集 - 检索应用集 - 《Zabbix 5.0 使用手册》

检索应用集

检索应用集

说明

integer/array application.get(object **parameters**)

该方法用于根据规定的参数获取应用集。

参数

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

该方法提供以下参数。

Parameter	Type	Description
applicationids	string/array	只返回指定 ID 的应用集。
groupids	string/array	只返回指定主机组所属主机的应用集。
hostids	string/array	只返回指定主机所属的应用集。
inherited	boolean	如果设定为`true`，只返回继承该模板的应用集。
itemids	string/array	只返回包含特定监控项的应用集。
templated	boolean	如果设定为`true`，只返回属于该模板的应用集。
templateids	string/array	只返回指定模板的应用集。

selectHost	query	返回值中会包括应用集所属的`主机名`属性。
selectItems	query	返回值中会应用集包含的`监控项`属性。
selectDiscoveryRule	query	返回值中会包括应用集的`底层自动发现规则`属性。
selectApplicationDiscovery	query	返回值中会包括应用集发现的对象属性。

sortfield	string/array	使用规定的属性将结果分类。可能的值：`applicationid` 和`name`。
countOutput	boolean	在 reference commentary 中详细描述了所有“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) 返回两者其中之一:

an array of objects;
如果已经使用了“countOutput”参数，则检索对象的计数.

范例

从主机中检索应用集

从主机中根据名称排序检索所有的应用集。

请求:

{
    "jsonrpc": "2.0",
    "method": "application.get",
    "params": {
        "output": "extend",
        "hostids": "10001",
        "sortfield": "name"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

响应:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "applicationid": "13",
            "hostid": "10001",
            "name": "CPU",
            "templateids": []
        },
        {
            "applicationid": "5",
            "hostid": "10001",
            "name": "Filesystems",
            "templateids": []
        },
        {
            "applicationid": "21",
            "hostid": "10001",
            "name": "General",
            "templateids": []
        },
        {
            "applicationid": "15",
            "hostid": "10001",
            "name": "Memory",
            "templateids": []
        },
    ],
    "id": 1
}

参考

来源

CApplication::get() in frontends/php/include/classes/api/services/CApplication.php.