获取

描述

integer/array maintenance.get(object parameters)

此方法允许根据给定参数检索维护。

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

参数

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

该方法支持以下参数。

参数 类型 描述
groupids ID/array 仅返回分配给指定主机组的维护。
hostids ID/array 仅返回分配给指定主机的维护。
maintenanceids ID/array 仅返回具有指定 ID 的维护。
selectHostGroups query 返回一个 hostgroups 属性，其中包含分配给该维护的主机组。
selectHosts query 返回一个 hosts 属性，其中包含分配给该维护的主机。
selectTags query 返回一个 tags 属性，其中包含该维护的问题标签。
selectTimeperiods query 返回一个 timeperiods 属性，其中包含该维护的时间段。
sortfield string/array 按给定属性对结果进行排序。

可选值：maintenanceid、name、maintenance_type、active_since、active_till。
countOutput boolean 这些参数在参考说明中进行了描述。
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 参数，则返回检索到的对象数量。

案例

检索维护

检索所有已配置的维护，以及有关已分配主机组、已定义时间段和问题标签的数据。

请求：

{
    "jsonrpc": "2.0",
    "method": "maintenance.get",
    "params": {
        "output": "extend",
        "selectHostGroups": "extend",
        "selectTimeperiods": "extend",
        "selectTags": "extend"
    },
    "id": 1
}

响应：

{
    "jsonrpc": "2.0",
    "result": [
        {
            "maintenanceid": "3",
            "name": "星期日维护",
            "maintenance_type": "0",
            "description": "",
            "active_since": "1358844540",
            "active_till": "1390466940",
            "tags_evaltype": "0",
            "hostgroups": [
                {
                    "groupid": "4",
                    "name": "Zabbix 服务器",
                    "flags": "0",
                    "uuid": "6f6799aa69e844b4b3918f779f2abf08"
                }
            ],
            "timeperiods": [
                {
                    "timeperiod_type": "3",
                    "every": "1",
                    "month": "0",
                    "dayofweek": "1",
                    "day": "0",
                    "start_time": "64800",
                    "period": "3600",
                    "start_date": "2147483647"
                }
            ],
            "tags": [
                {
                    "tag": "service",
                    "operator": "0",
                    "value": "mysqld",
                },
                {
                    "tag": "error",
                    "operator": "2",
                    "value": ""
                }
            ]
        }
    ],
    "id": 1
}

另请参阅

源代码

位于 ui/include/classes/api/services/CMaintenance.php 中的 CMaintenance::get()。