maintenance.update

説明

object maintenance.update(object/array maintenances)

このメソッドを使用すると、既存のメンテナンスを更新できます。

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

パラメータ

(object/array) 更新するメンテナンスのプロパティ。

各メンテナンスに対してmaintenanceidプロパティを定義する必要があります。それ以外のプロパティは任意です。渡されたプロパティのみが更新され、それ以外のプロパティは変更されません。

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

Parameter Type Description
groups object/array 現在のホストグループを置き換えるホストグループ。

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

パラメータの動作:
- hostsが設定されていない場合は必須
hosts object/array 現在のホストを置き換えるホスト。

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

パラメータの動作:
- groupsが設定されていない場合は必須
triggers object/array 現在のトリガーを置き換えるトリガー。

トリガーにはtriggeridプロパティのみを定義する必要があります。

パラメータの動作:
- groupsとhostsが設定されていない場合は必須
- maintenance_type=0（データ収集あり）の場合にサポート
event_names object/array 現在のイベント名を置き換えるイベント名。

パラメータの動作:
- maintenance_type=0（データ収集あり）の場合にサポート
tags object/array 現在のタグを置き換える障害タグ。

パラメータの動作:
- Maintenanceオブジェクトのmaintenance_typeが「データ収集あり」に設定されている場合にサポート
timeperiods object/array 現在の期間を置き換えるメンテナンスのタイム期間。

戻り値

(object) maintenanceidsプロパティの下で更新されたメンテナンスのIDを含むオブジェクトを返します。

例

異なるホストの割り当て

現在メンテナンスに割り当てられているホストを2つの異なるホストに置き換えます。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "maintenance.update",
    "params": {
        "maintenanceid": "3",
        "hosts": [
            {"hostid": "10085"},
            {"hostid": "10084"}
        ]
    },
    "id": 1
}

レスポンス:

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

関連項目

ソース

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