获取

描述

integer/array maintenance.get(object parameters)

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

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

参数

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

此方法支持以下参数。

参数 类型 描述
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。
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
selectGroups
(已弃用)		 query 此参数已弃用，请使用 selectHostGroups 代替。
返回一个带有分配给维护的主机组的 groups 属性。

返回值

(整型/数组) 返回其中之一：

  • 一个对象数组；
  • 如果使用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": "Sunday maintenance",
            "maintenance_type": "0",
            "description": "",
            "active_since": "1358844540",
            "active_till": "1390466940",
            "tags_evaltype": "0",
            "hostgroups": [
                {
                    "groupid": "4",
                    "name": "Zabbix servers",
                    "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
}

参见

来源

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