maintenance.create

説明

object maintenance.create(object/array maintenances)

このメソッドは、新しいメンテナンスを作成するためのものです。

このメソッドは 管理者 および スーパ管理者 ユーザータイプでのみ利用可能です。メソッドの呼び出し権限はユーザーロール設定で取り消すことができます。詳細はユーザーロールを参照してください。

パラメータ

(object/array) 作成するメンテナンス。

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

パラメータ 型 説明
groups object/array メンテナンスを実施するホストグループ。

ホストグループにはgroupidプロパティのみを定義する必要があります。

パラメータの動作:
- hostsが設定されていない場合は必須
hosts object/array メンテナンスを実施するホスト。

ホストにはhostidプロパティのみを定義する必要があります。

パラメータの動作:
- groupsが設定されていない場合は必須
timeperiods object/array メンテナンスの期間。

パラメータの動作:
- 必須
tags object/array 問題タグ。

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

パラメータの動作:
- Maintenance objectのmaintenance_typeが「データ収集あり」に設定されている場合にサポート

戻り値

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

例

メンテナンスの作成

ID "2" のホストグループに対して、service:mysqld および error の問題タグを持つデータ収集付きのメンテナンスを作成します。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() in ui/include/classes/api/services/CMaintenance.php.