获取维护期
描述
integer/array maintenance.get(object parameters)
此方法用于根据给定参数获取维护模式。
任何类型的用户都可以使用此方法。权限可以在用户角色设置中撤消调用该方法。了解更多信息可以参见用户角色。
参数
(object) 定义所需输出的参数。
该方法支持以下参数。
| 参数 | 类型 | 说明 |
|---|---|---|
| groupids | string/array | 只返回分配给给定主机组的维护。 |
| hostids | string/array | 仅返回分配给给定主机的维护。 |
| maintenanceids | string/array | 只返回给定 ID 的维护。 |
| selectGroups | query | 返回一个 groups 属性，其中主机组分配给维护。 |
| selectHosts | query | 返回一个 hosts 属性，其中主机分配给维护。 |
| selectTags | query | 返回带有维护问题标签的 tags 属性。 |
| selectTimeperiods | query | 返回带有维护时间段的 timeperiods 属性。 |
| sortfield | string/array | 按给定属性对结果进行排序。 可用值： maintenanceid、name 和 maintenance_type。 |
| countOutput | boolean | 这些参数对所有 get 方法都是通用的，在 参考评论 中有详细描述。 |
| 可编辑 | boolean | |
| 排除搜索 | boolean | |
| 过滤器 | object | |
| 限制 | integer | |
| 输出 | query | |
| preservekeys | boolean | |
| 搜索 | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| 排序 | string/array | |
| 开始搜索 | boolean |
返回值
(整型/数组) 返回其中之一： - 一个对象数组； - 如果使用countOutput参数，被检索对象的数量。
案例
检索维护周期
检索所有已配置的维护，以及有关分配的主机组、定义的时间段和问题标签的数据。 请求:
{
"jsonrpc": "2.0",
"method": "maintenance.get",
"params": {
"output": "extend",
"selectGroups": "extend",
"selectTimeperiods": "extend",
"selectTags": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}响应:
{
"jsonrpc": "2.0",
"result": [
{
"maintenanceid": "3",
"name": "Sunday maintenance",
"maintenance_type": "0",
"description": "",
"active_since": "1358844540",
"active_till": "1390466940",
"tags_evaltype": "0",
"groups": [
{
"groupid": "4",
"name": "Zabbix servers",
"internal": "0"
}
],
"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.