item.update

説明

object item.update(object/array items)

このメソッドは、既存のアイテムを更新するためのものです。

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

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

パラメータ

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

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

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

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

パラメータの動作:
- 継承オブジェクトまたは検出オブジェクトの場合は読み取り専用
tags array アイテムタグ。

パラメータの動作:
- 検出オブジェクトの場合は読み取り専用

戻り値

(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": "従属アイテムの更新名",
        "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.