integer/array maintenance.get(object parameters)
该方法允许根据给定的参数检索维护信息。
此方法适用于任何类型的用户。可以在用户角色设置中撤销调用该方法的权限。更多信息请参见 User roles。
(object)
用于定义期望输出的参数。
该方法支持以下参数:
参数 | 数据类型 | 描述 |
---|---|---|
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 (deprecated) |
query | 此参数已弃用,请使用 selectHostGroups 替代。返回一个 groups 属性,包含分配给该维护的 主机 组。 |
(integer/array)
返回以下之一:
countOutput
参数,则为检索到的 objects 的数量。检索所有已配置的维护,以及关于已分配的 主机组、定义的时间段和问题标签的数据。
执行请求:
{
"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 中。