maintenance.update

説明

object maintenance.update(object/array maintenances)

このメソッドは、既存のメンテナンスを更新するためのものです。

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

パラメータ

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

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

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

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

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

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

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

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

パラメータの動作:
- メンテナンスオブジェクトの maintenance_type が「データ収集あり」に設定されている場合にサポート

戻り値

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