获取

描述

integer/array maintenance.get(object parameters)

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

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

参数

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

此方法支持以下参数。

参数类型描述
groupidsID/array仅返回分配给给定主机组的维护。
hostidsID/array仅返回分配给给定主机的维护。
maintenanceidsID/array仅返回具有给定 ID 的维护。
selectHostGroupsquery返回一个带有分配给维护的主机组的 hostgroups 属性。
selectHostsquery返回一个带有分配给维护的主机的 hosts 属性。
selectTagsquery返回一个带有维护的问题标签的 tags 属性。
selectTimeperiodsquery返回一个带有维护的时间段的 timeperiods 属性。
sortfieldstring/array按给定属性对结果进行排序。

可能的值: maintenanceid、name、maintenance_type。
countOutputboolean这些对于所有 get 方法通用的参数在 参考说明 中有详细描述。
editableboolean
excludeSearchboolean
filterobject
limitinteger
outputquery
preservekeysboolean
searchobject
searchByAnyboolean
searchWildcardsEnabledboolean
sortorderstring/array
startSearchboolean
selectGroups
(已弃用)		query此参数已弃用，请使用 selectHostGroups 代替。
返回一个带有分配给维护的主机组的 groups 属性。

返回值

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

案例

检索维护周期

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

请求：

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

响应：

  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.                    "hostgroups": [
  13.                        {
  14.                            "groupid": "4",
  15.                            "name": "Zabbix servers",
  16.                            "flags": "0",
  17.                            "uuid": "6f6799aa69e844b4b3918f779f2abf08"
  18.                        }
  19.                    ],
  20.                    "timeperiods": [
  21.                        {
  22.                            "timeperiod_type": "3",
  23.                            "every": "1",
  24.                            "month": "0",
  25.                            "dayofweek": "1",
  26.                            "day": "0",
  27.                            "start_time": "64800",
  28.                            "period": "3600",
  29.                            "start_date": "2147483647"
  30.                        }
  31.                    ],
  32.                    "tags": [
  33.                        {
  34.                            "tag": "service",
  35.                            "operator": "0",
  36.                            "value": "mysqld",
  37.                        },
  38.                        {
  39.                            "tag": "error",
  40.                            "operator": "2",
  41.                            "value": ""
  42.                        }
  43.                    ]
  44.                }
  45.            ],
  46.            "id": 1
  47.        }

参见

来源

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