item.update

説明

object item.update(object/array items)

このメソッドでは、既存のアイテムを更新できます。

WebアイテムはZabbix API経由では更新できません。

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

パラメータ

(object/array) 更新するアイテムのプロパティ。

各アイテムに対して itemid プロパティを定義する必要があり、その他の プロパティはすべて任意です。渡されたプロパティのみが更新され、その他 はすべて変更されません。

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

パラメータ 説明
preprocessing array 現在の前処理オプションを置き換えるためのアイテムの前処理オプション。

パラメータの動作:
- 継承されたオブジェクトまたはディスカバリされたオブジェクトでは read-only
tags array アイテムタグ

パラメータの動作:
- ディスカバリされたオブジェクトでは read-only

戻り値

(object) itemids プロパティの下で更新されたアイテムの ID を含むオブジェクトを返します。

アイテムの有効化

アイテムを有効化します。つまり、ステータスを "0" に設定します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "item.update",
    "params": {
        "itemid": "10092",
        "status": 0
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "itemids": [
            "10092"
        ]
    },
    "id": 1
}

依存アイテムの更新

依存アイテム名とマスターアイテムIDを更新します。同じホスト上の依存関係のみ許可されるため、マスターアイテムと依存アイテムは同じhostidを持っている必要があります。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "item.update",
    "params": {
        "name": "Dependent item updated name",
        "master_itemid": "25562",
        "itemid": "189019"
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "itemids": [
            "189019"
        ]
    },
    "id": 1
}

HTTPエージェントアイテムの更新

アイテム値のトラップを有効にします。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "item.update",
    "params": {
        "itemid": "23856",
        "allow_traps": 1
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "itemids": [
            "23856"
        ]
    },
    "id": 1
}

前処理を使用したアイテムの更新

アイテムの前処理ルール「範囲内」を使用してアイテムを更新します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "item.update",
    "params": {
        "itemid": "23856",
        "preprocessing": [
            {
                "type": 13,
                "params": "\n100",
                "error_handler": 1,
                "error_handler_params": ""
            }
        ]
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "itemids": [
            "23856"
        ]
    },
    "id": 1
}

スクリプトアイテムの更新

スクリプトアイテムを別のスクリプトで更新し、以前のスクリプトで使用されていた不要なパラメータを削除します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "item.update",
    "params": {
        "itemid": "23865",
        "parameters": [],
        "params": "Zabbix.log(3, 'Log test');\nreturn 1;"
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "itemids": [
            "23865"
        ]
    },
    "id": 1
}

ソース

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