maintenance.update

説明

object maintenance.update(object/array maintenances)

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

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

パラメータ

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

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

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

パラメータ 型 説明
groups object/array 現在のグループを置き換えるホストグループ。

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

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

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

パラメータの動作:
- groups が設定されていない場合は 必須
timeperiods object/array 現在の期間を置き換えるメンテナンスの期間。
tags object/array 現在のタグを置き換える障害タグ。

パラメータの動作:
- メンテナンスオブジェクト の maintenance_type が "with data collection" に設定されている場合に サポート

戻り値

(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.