maintenance.get

描述

integer/array maintenance.get(object parameters)

该方法允许根据指定参数检索维护事件。

此方法可供任何类型的用户使用。调用该方法的权限可通过用户角色设置进行撤销。更多信息请参阅User roles

参数

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

该方法支持以下参数。

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

可能值为:maintenanceidnamemaintenance_type
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) 返回以下两种结果之一:

  • 一个包含objects的array;
  • 若使用了countOutput参数,则返回检索到的objects数量。

示例

检索维护周期

获取所有已配置的维护周期信息,包括关联的主机组、定义的时间段及问题标签数据。

请求:

{
           "jsonrpc": "2.0",
           "method": "maintenance.get",
           "params": {
               "output": "extend",
               "selectGroups": "extend",
               "selectTimeperiods": "extend",
               "selectTags": "extend"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "maintenanceid": "3",
                   "name": "Sunday maintenance",
                   "maintenance_type": "0",
                   "description": "",
                   "active_since": "1358844540",
                   "active_till": "1390466940",
                   "tags_evaltype": "0",
                   "groups": [
                       {
                           "groupid": "4",
                           "name": "Zabbix servers",
                           "internal": "0"
                       }
                   ],
                   "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
       }

另请参阅

来源

CMaintenance::get() 方法位于 ui/include/classes/api/services/CMaintenance.php 文件中。