This is a translation of the original English documentation page. Help us make it better.

maintenance.create

説明

object maintenance.create(object/array maintenances)

このメソッドで、新しいメンテナンスを作成できます。

このメソッドはAdminおよびSuper adminユーザータイプでのみ使用できます。 メソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。 詳細についてはユーザーの役割を参照してください。

パラメータ

(object/array) メンテナンスの作成

このメソッドは標準のメンテナンスプロパティに加えて、次のパラメーターを受け入れます。

パラメータ タイプ 説明
groups object/array メンテナンスが行われるホストgroups

ホストグループにはgroupidプロパティが定義されている必要があります。

groupsまたはhostsのオブジェクトを少なくとも1つ指定する必要があります。
hosts object/array メンテナンスが行われるホスト

ホストにはhostidプロパティが定義されている必要があります。

groupsまたはhostsのオブジェクトを少なくとも1つ指定する必要があります。
timeperiods
(必須)
object/array メンテナンス期間
tags object/array 障害タグ

どの障害を抑制するかを定義します。
タグが指定されていない場合、すべてのアクティブなメンテナンスホストの障害が抑制されます。

戻り値

(object) maintenanceidsプロパティの下で作成されたメンテナンスのIDを含むオブジェクトを返します。 返されるIDの順序は、渡されたメンテナンスの順序と一致します。

メンテナンスの作成

ID"2"のホストグループのデータ収集と、障害タグservice:mysqldおよびerrorを使用してメンテナンスを作成します。 2013年1月22日から2014年1月22日までアクティブで、毎週日曜日の18:00に有効になり1時間持続します。

Request:

{
           "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": ""
                   }
               ]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

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

参照

ソース

CMaintenance::create() in ui/include/classes/api/services/CMaintenance.php.