获取

描述

integer/array maintenance.get(object parameters)

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

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

参数

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

该方法支持以下参数。

参数 类型 描述
groupids ID/array 仅返回分配给指定主机组的维护。
hostids ID/array 仅返回分配给指定主机的维护。
triggerids ID/array 仅返回分配给指定触发器的维护。
maintenanceids ID/array 仅返回具有指定 ID 的维护。
selectHostGroups query 返回一个 hostgroups 属性，其中包含分配给该维护的主机组。
selectHosts query 返回一个 hosts 属性，其中包含分配给该维护的主机。
selectTriggers query 返回一个 triggers 属性，其中包含分配给该维护的触发器。
selectEventNames query 返回一个 event_names 属性，其中包含分配给该维护的事件名称。
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",
        "selectHosts": "extend",
        "selectTriggers": "extend",
        "selectEventNames": "extend",
        "selectTags": "extend",
        "selectTimeperiods": "extend"
    },
    "id": 1
}

响应：


{
  "jsonrpc": "2.0",
  "result": [
    {
      "maintenanceid": "1",
      "name": "常规数据库维护",
      "maintenance_type": "0",
      "description": "",
      "active_since": "1791936000",
      "active_till": "2107555200",
      "tags_evaltype": "0",
      "hostgroups": [
        {
          "groupid": "20",
          "name": "数据库",
          "flags": "0",
          "uuid": "748ad4d098d447d492bb935c907f652f"
        }
      ],
      "triggers": [],
      "event_names": [],
      "hosts": [],
      "tags": [],
      "timeperiods": [
        {
          "timeperiod_type": "4",
          "every": "1",
          "month": "4095",
          "dayofweek": "0",
          "day": "1",
          "start_time": "64800",
          "period": "3600",
          "start_date": "0"
        }
      ]
    },
    {
      "maintenanceid": "2",
      "name": "临时维护：打印机：墨水耗尽",
      "maintenance_type": "0",
      "description": "",
      "active_since": "1792057740",
      "active_till": "1792061340",
      "tags_evaltype": "0",
      "hostgroups": [
        {
          "groupid": "4",
          "name": "Zabbix 服务器",
          "flags": "0",
          "uuid": "6f6799aa69e844b4b3918f779f2abf08"
        }
      ],
      "triggers": [],
      "event_names": [
        {
          "operator": "2",
          "value": "打印机：墨水耗尽"
        }
      ],
      "hosts": [],
      "tags": [],
      "timeperiods": [
        {
          "timeperiod_type": "0",
          "every": "1",
          "month": "0",
          "dayofweek": "0",
          "day": "0",
          "start_time": "0",
          "period": "3600",
          "start_date": "1792057740"
        }
      ]
    }
  ],
  "id": 1
}```

[comment]: # ({/ec7146e4-0b1cb387})

[comment]: # ({0c4dce96-dbcf678a})
### 另请参阅

-   [主机](/manual/api/reference/host/object#host)
-   [主机组](/manual/api/reference/hostgroup/object#host-group)
-   [触发器](/manual/api/reference/trigger/object#trigger)
-   [事件名称](object#event-name)
-   [问题标签](object#problem-tag)
-   [时间段](object#time-period)

[comment]: # ({/0c4dce96-dbcf678a})

[comment]: # ({f0ec3c40-50ed5be3})
### 源代码

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

[comment]: # ({/f0ec3c40-50ed5be3})