获取维护期

描述

integer/array maintenance.get(object parameters)

此方法用于根据给定参数获取维护模式。

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

参数

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

该方法支持以下参数。

参数类型说明
groupidsstring/array只返回分配给给定主机组的维护。
hostidsstring/array仅返回分配给给定主机的维护。
maintenanceidsstring/array只返回给定 ID 的维护。
selectGroupsquery返回一个 groups 属性,其中主机组分配给维护。
selectHostsquery返回一个 hosts 属性,其中主机分配给维护。
selectTagsquery返回带有维护问题标签的 tags 属性。
selectTimeperiodsquery返回带有维护时间段的 timeperiods 属性。
sortfieldstring/array按给定属性对结果进行排序。

可用值:maintenanceidnamemaintenance_type
countOutputboolean这些参数对所有 get 方法都是通用的,在 参考评论 中有详细描述。
可编辑boolean
排除搜索boolean
过滤器object
限制integer
输出query
preservekeysboolean
搜索object
searchByAnyboolean
searchWildcardsEnabledboolean
排序string/array
开始搜索boolean

返回值

(整型/数组) 返回其中之一: - 一个对象数组; - 如果使用countOutput参数,被检索对象的数量。

案例

检索维护模式

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

  1. {
  2. "jsonrpc": "2.0",
  3. "method": "maintenance.get",
  4. "params": {
  5. "output": "extend",
  6. "selectGroups": "extend",
  7. "selectTimeperiods": "extend",
  8. "selectTags": "extend"
  9. },
  10. "auth": "038e1d7b1735c6a5436ee9eae095879e",
  11. "id": 1
  12. }

响应:

  1. {
  2. "jsonrpc": "2.0",
  3. "result": [
  4. {
  5. "maintenanceid": "3",
  6. "name": "Sunday maintenance",
  7. "maintenance_type": "0",
  8. "description": "",
  9. "active_since": "1358844540",
  10. "active_till": "1390466940",
  11. "tags_evaltype": "0",
  12. "groups": [
  13. {
  14. "groupid": "4",
  15. "name": "Zabbix servers",
  16. "internal": "0"
  17. }
  18. ],
  19. "timeperiods": [
  20. {
  21. "timeperiod_type": "3",
  22. "every": "1",
  23. "month": "0",
  24. "dayofweek": "1",
  25. "day": "0",
  26. "start_time": "64800",
  27. "period": "3600",
  28. "start_date": "2147483647"
  29. }
  30. ],
  31. "tags": [
  32. {
  33. "tag": "service",
  34. "operator": "0",
  35. "value": "mysqld",
  36. },
  37. {
  38. "tag": "error",
  39. "operator": "2",
  40. "value": ""
  41. }
  42. ]
  43. }
  44. ],
  45. "id": 1
  46. }

参见

来源

CMaintenance::get() 在 ui/include/classes/api/services/CMaintenance.php.