Documentation
maintenance.get
描述
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, active_since, active_till. |
| 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) 返回以下两种情况之一:
- 一个array的objects;
- 检索到的objects数量，如果使用了
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 文件中。