maintenance.create

描述

object maintenance.create(object/array maintenances)

该方法允许create新的维护周期.

此方法仅限管理员超级管理员用户类型使用. 调用该方法的权限可通过用户角色设置进行撤销. 更多信息请参阅User roles.

参数

(object/array) 维护以create.

除了维护之外,该方法还接受以下参数.

参数 数据类型 描述
groups object/array 将进入维护状态的Host groups.

主机组必须仅定义groupid属性.

参数行为:
- 必需 如果未设置hosts
hosts object/array 将进入维护状态的Hosts.

主机必须仅定义hostid属性.

参数行为:
- 必需 如果未设置groups
timeperiods object/array 维护时间段.

参数行为:
- 必需
tags object/array 问题标签.

定义必须抑制的问题类型.
如果未提供标签,将抑制所有活动维护主机问题.

参数行为:
- 支持 如果维护maintenance_type设置为"with data collection"

返回值

(object) 返回一个包含所创建维护ID的object,这些ID存储在maintenanceids属性下。返回的ID顺序与传入的维护顺序相匹配。

示例

创建维护周期

为ID为"2"的主机组创建数据收集维护周期,需包含问题标签service:mysqlderror。该维护周期从2013年1月22日生效至2014年1月22日,每周日18:00开始执行,持续1小时。

执行请求:

{
           "jsonrpc": "2.0",
           "method": "maintenance.create",
           "params": {
               "name": "Sunday maintenance",
               "active_since": 1358844540,
               "active_till": 1390466940,
               "tags_evaltype": 0,
               "groups": [
                   {"groupid": "2"}
               ],
               "timeperiods": [
                   {
                       "period": 3600,
                       "timeperiod_type": 3,
                       "start_time": 64800,
                       "every": 1,
                       "dayofweek": 64
                   }
               ],
               "tags": [
                   {
                       "tag": "service",
                       "operator": "0",
                       "value": "mysqld"
                   },
                   {
                       "tag": "error",
                       "operator": "2",
                       "value": ""
                   }
               ]
           },
           "id": 1
       }

响应:

{
           "jsonrpc": "2.0",
           "result": {
               "maintenanceids": [
                   "3"
               ]
           },
           "id": 1
       }

另请参阅

来源

CMaintenance::create() 位于 ui/include/classes/api/services/CMaintenance.php 文件中.