Itemオブジェクト

次のオブジェクトは、itemAPIに直接関連しています。

アイテム

Webアイテムは、Zabbix APIを介して直接作成、更新、削除することはできません。

アイテムオブジェクトには、次のプロパティがあります。

Property Type Description
itemid ID アイテムのIDです。

Property behavior:
- 読み取り専用
- 更新操作では必須
delay string アイテムの更新間隔です。

秒、または接尾辞付きの時間単位(例: 30s、1m、2h、1d)を指定できます。さらに、1つ以上のカスタム間隔を任意で指定でき、それらはすべてセミコロンで区切ります。カスタム間隔には、柔軟間隔とスケジュール間隔を混在させることができます。

ユーザーマクロを指定できます。使用する場合、値は単一のマクロでなければなりません。複数のマクロや、マクロとテキストを混在させることはできません。柔軟間隔は、スラッシュで区切った2つのマクロとして記述できます(例: {$FLEX_INTERVAL}/{$FLEX_PERIOD})。

例:
1h;wd1-5h9-18;{$Macro1}/1-7,00:00-24:00;0/6-7,12:00-24:00;{$Macro2}/{$Macro3}

Property behavior:
- type が "Zabbix agent" (0), "Simple check" (3), "Zabbix internal" (5), "External check" (10), "Database monitor" (11), "IPMI agent" (12), "SSH agent" (13), "TELNET agent" (14), "Calculated" (15), "JMX agent" (16), "HTTP agent" (19), "SNMP agent" (20), "Script" (21), "Browser" (22) に設定されている場合、または type が "Zabbix agent (active)" (7) で key_ に "mqtt.get" が含まれない場合は必須
hostid ID アイテムが属するホストまたはテンプレートのIDです。

Property behavior:
- 定数
- 作成操作では必須
interfaceid ID アイテムのホストインターフェースのIDです。

Property behavior:
- アイテムがホストに属し、type が "Zabbix agent", "IPMI agent", "JMX agent", "SNMP trap", または "SNMP agent" に設定されている場合は必須
- アイテムがホストに属し、type が "Simple check", "External check", "SSH agent", "TELNET agent", または "HTTP agent" に設定されている場合はサポート対象
- 発見されたオブジェクトでは読み取り専用
key_ string アイテムキーです。

Property behavior:
- 作成操作では必須
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
name string アイテムの名前です。
ユーザーマクロをサポートします。

Property behavior:
- 作成操作では必須
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
name_resolved string ユーザーマクロが解決されたアイテム名です。

Property behavior:
- 読み取り専用
type integer アイテムのタイプです。

可能な値:
0 - Zabbix agent;
2 - Zabbix trapper;
3 - Simple check;
5 - Zabbix internal;
7 - Zabbix agent (active);
9 - Web item;
10 - External check;
11 - Database monitor;
12 - IPMI agent;
13 - SSH agent;
14 - TELNET agent;
15 - Calculated;
16 - JMX agent;
17 - SNMP trap;
18 - Dependent item;
19 - HTTP agent;
20 - SNMP agent;
21 - Script;
22 - Browser.

Property behavior:
- 作成操作では必須
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
url string URL文字列です。
ユーザーマクロ、{HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY} をサポートします。

Property behavior:
- type が "HTTP agent" に設定されている場合は必須
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
value_type integer アイテムの情報タイプです。

可能な値:
0 - numeric float;
1 - character;
2 - log;
3 - numeric unsigned;
4 - text;
5 - binary;
6 - JSON.

Property behavior:
- 作成操作では必須
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
allow_traps integer トラッパーアイテムと同様に値の取り込みを許可します。

0 - (default) 受信データの受け入れを許可しない;
1 - 受信データの受け入れを許可する。

Property behavior:
- type が "HTTP agent" に設定されている場合はサポート対象
- 発見されたオブジェクトでは読み取り専用
authtype integer 認証方式です。

type が "SSH agent" に設定されている場合の可能な値:
0 - (default) パスワード;
1 - 公開鍵。

type が "HTTP agent" に設定されている場合の可能な値:
0 - (default) なし;
1 - basic;
2 - NTLM;
3 - Kerberos;
4 - Digest.

Property behavior:
- type が "SSH agent" または "HTTP agent" に設定されている場合はサポート対象
- 継承されたオブジェクト(type が "HTTP agent" の場合)または発見されたオブジェクトでは読み取り専用
description string アイテムの説明です。

Property behavior:
- 発見されたオブジェクトでは読み取り専用
error string アイテム値の更新に問題がある場合のエラーテキストです。

Property behavior:
- 読み取り専用
flags integer アイテムのOriginです。

可能な値:
0 - 通常のアイテム;
4 - プロトタイプから変換されたアイテム。

Property behavior:
- 読み取り専用
follow_redirects integer データ取得時にレスポンスのリダイレクトを追跡するかどうかです。

可能な値:
0 - リダイレクトを追跡しない;
1 - (default) リダイレクトを追跡する。

Property behavior:
- type が "HTTP agent" に設定されている場合はサポート対象
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
headers array HTTPリクエスト実行時に送信されるヘッダーの配列です。

Property behavior:
- type が "HTTP agent" に設定されている場合はサポート対象
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
history string 履歴データを保存する期間を表す時間単位です。
ユーザーマクロも指定できます。

Default: 31d.

Property behavior:
- 発見されたオブジェクトでは読み取り専用
http_proxy string HTTP(S)プロキシ接続文字列です。

Property behavior:
- type が "HTTP agent" に設定されている場合はサポート対象
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
inventory_link integer アイテムによって設定されるホストインベントリフィールドのIDです。

サポートされるホストインベントリフィールドとそのIDの一覧については、ホストインベントリページを参照してください。

Default: 0.

Property behavior:
- value_type が "numeric float", "character", "numeric unsigned", または "text" に設定されている場合はサポート対象
- 発見されたオブジェクトでは読み取り専用
ipmi_sensor string IPMIセンサーです。

Property behavior:
- type が "IPMI agent" に設定され、かつ key_ が "ipmi.get" に設定されていない場合は必須
- type が "IPMI agent" に設定されている場合はサポート対象
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
jmx_endpoint string JMXエージェントのカスタム接続文字列です。

Default value: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi

Property behavior:
- type が "JMX agent" に設定されている場合はサポート対象
- 発見されたオブジェクトでは読み取り専用
lastclock timestamp アイテム値が最後に更新された時刻です。

デフォルトでは、直近24時間以内の値のみが表示されます。この期間は、Administration > General メニューセクションの Max history display period パラメータの値を変更することで延長できます。

Property behavior:
- 読み取り専用
lastns integer アイテム値が最後に更新されたナノ秒です。

デフォルトでは、直近24時間以内の値のみが表示されます。この期間は、Administration > General メニューセクションの Max history display period パラメータの値を変更することで延長できます。

Property behavior:
- 読み取り専用
lastvalue string アイテムの最新値です。

デフォルトでは、直近24時間以内の値のみが表示されます。この期間は、Administration > General メニューセクションの Max history display period パラメータの値を変更することで延長できます。

Property behavior:
- 読み取り専用
logtimefmt string ログエントリ内の時刻の形式です。

Property behavior:
- value_type が "log" に設定されている場合はサポート対象
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
master_itemid ID マスターアイテムのIDです。

Property behavior:
- type が "Dependent item" に設定されている場合は必須
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
output_format integer レスポンスをJSONに変換するかどうかです。

0 - (default) 生データを保存;
1 - JSONに変換。

Property behavior:
- type が "HTTP agent" に設定されている場合はサポート対象
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
params string アイテムのタイプに応じた追加パラメータです:
- SSH agent および TELNET agent アイテムでは実行するスクリプト;
- database monitor アイテムではSQLクエリ;
- calculated アイテムでは数式;
- script および browser アイテムではスクリプト。

Property behavior:
- type が "Database monitor", "SSH agent", "TELNET agent", "Calculated", "Script", または "Browser" に設定されている場合は必須
- 継承されたオブジェクト(type が "Script" または "Browser" の場合)または発見されたオブジェクトでは読み取り専用
parameters object/array type が "Script" または "Browser" に設定されている場合の追加パラメータです。namevalue プロパティを持つオブジェクトの配列で、name は一意でなければなりません。

Property behavior:
- type が "Script" または "Browser" に設定されている場合はサポート対象
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
password string 認証用パスワードです。

Property behavior:
- type が "JMX agent" に設定され、username が設定されている場合は必須
- type が "Simple check", "SSH agent", "TELNET agent", "Database monitor", または "HTTP agent" に設定されている場合はサポート対象
- 継承されたオブジェクト(type が "HTTP agent" の場合)または発見されたオブジェクトでは読み取り専用
post_type integer posts プロパティに保存されるPOSTデータ本文のタイプです。

可能な値:
0 - (default) Raw data;
2 - JSON data;
3 - XML data.

Property behavior:
- type が "HTTP agent" に設定されている場合はサポート対象
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
posts string HTTP(S)リクエスト本文データです。

Property behavior:
- type が "HTTP agent" で post_type が "JSON data" または "XML data" に設定されている場合は必須
- type が "HTTP agent" で post_type が "Raw data" に設定されている場合はサポート対象
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
prevvalue string アイテムの前回値です。

デフォルトでは、直近24時間以内の値のみが表示されます。この期間は、Administration > General メニューセクションの Max history display period パラメータの値を変更することで延長できます。

Property behavior:
- 読み取り専用
privatekey string 秘密鍵ファイル名です。

Property behavior:
- type が "SSH agent" で authtype が "public key" に設定されている場合は必須
- 発見されたオブジェクトでは読み取り専用
publickey string 公開鍵ファイル名です。

Property behavior:
- type が "SSH agent" で authtype が "public key" に設定されている場合は必須
- 発見されたオブジェクトでは読み取り専用
query_fields array HTTPリクエスト実行時に送信されるクエリフィールドの配列です。

Property behavior:
- type が "HTTP agent" に設定されている場合はサポート対象
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
request_method integer リクエストメソッドのタイプです。

可能な値:
0 - (default) GET;
1 - POST;
2 - PUT;
3 - HEAD.

Property behavior:
- type が "HTTP agent" に設定されている場合はサポート対象
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
retrieve_mode integer レスポンスのどの部分を保存するかです。

request_method が "GET", "POST", または "PUT" に設定されている場合の可能な値:
0 - (default) 本文;
1 - ヘッダー;
2 - 本文とヘッダーの両方を保存。

request_method が "HEAD" に設定されている場合の可能な値:
1 - ヘッダー。

Property behavior:
- type が "HTTP agent" に設定されている場合はサポート対象
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
snmp_oid string SNMP OIDです。

Property behavior:
- type が "SNMP agent" に設定されている場合は必須
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
ssl_cert_file string 公開SSL鍵ファイルのパスです。

Property behavior:
- type が "HTTP agent" に設定されている場合はサポート対象
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
ssl_key_file string 秘密SSL鍵ファイルのパスです。

Property behavior:
- type が "HTTP agent" に設定されている場合はサポート対象
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
ssl_key_password string SSL鍵ファイルのパスワードです。

Property behavior:
- type が "HTTP agent" に設定されている場合はサポート対象
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
state integer アイテムの状態です。

可能な値:
0 - (default) 正常;
1 - サポートされていない。

Property behavior:
- 読み取り専用
status integer アイテムのステータスです。

可能な値:
0 - (default) 有効なアイテム;
1 - 無効なアイテム。
status_codes string 必要なHTTPステータスコードの範囲を、カンマ区切りで指定します。
カンマ区切りリストの一部としてユーザーマクロもサポートします。

例: 200,200-{$M},{$M},200-400

Property behavior:
- type が "HTTP agent" に設定されている場合はサポート対象
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
templateid ID 親テンプレートアイテムのIDです。

ヒント: アイテムが属するテンプレートを指定するには hostid プロパティを使用してください。

Property behavior:
- 読み取り専用
timeout string アイテムデータ取得リクエストのタイムアウトです。
秒、または接尾辞付きの時間単位(例: 30s、1m)を指定できます。ユーザーマクロも指定できます。

可能な値の範囲: 1-600s。

Default: "" - プロキシ/グローバル設定を使用。

Property behavior:
- type が "Zabbix agent" (0), "Simple check" (3) で key_ が "vmware." および "icmpping" で始まらない場合, "Zabbix agent (active)" (7), "External check" (10), "Database monitor" (11), "SSH agent" (13), "TELNET agent" (14), "HTTP agent" (19), "SNMP agent" (20) で snmp_oid が "walk[" または "get[" で始まる場合, "Script" (21), "Browser" (22) はサポート対象
- 継承されたオブジェクトおよび発見されたオブジェクトでは読み取り専用
trapper_hosts string 許可されたホストです。

Property behavior:
- 発見されたオブジェクトではreadonly
- type が "Zabbix trapper" に設定されている場合、または type が "HTTP agent" で allow_traps が "受信データの受け入れを許可する" に設定されている場合はサポート対象
trends string トレンドデータを保存する期間を表す時間単位です。
ユーザーマクロも指定できます。

Default: 365d.

Property behavior:
- value_type が "numeric float" または "numeric unsigned" に設定されている場合はサポート対象
- 発見されたオブジェクトでは読み取り専用
units string 値の単位です。

Property behavior:
- value_type が "numeric float" または "numeric unsigned" に設定されている場合はサポート対象
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
username string 認証用ユーザー名です。

Property behavior:
- type が "SSH agent", "TELNET agent" に設定されている場合、または type が "JMX agent" で password が設定されている場合は必須
- type が "Simple check", "Database monitor", または "HTTP agent" に設定されている場合はサポート対象
- 継承されたオブジェクト(type が "HTTP agent" の場合)または発見されたオブジェクトでは読み取り専用
uuid string インポートされたアイテムを既存のアイテムに関連付けるために使用される、ユニバーサル一意識別子です。指定されていない場合は自動生成されます。

Property behavior:
- アイテムがテンプレートに属する場合はサポート対象
valuemapid ID 関連付けられた値マップのIDです。

Property behavior:
- value_type が "numeric float", "character", または "numeric unsigned" に設定されている場合はサポート対象
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
verify_host integer 接続先のホスト名がホスト証明書内のものと一致するかどうかを検証するかどうかです。

可能な値:
0 - (default) 検証しない;
1 - 検証する。

Property behavior:
- type が "HTTP agent" に設定されている場合はサポート対象
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用
verify_peer integer ホストの証明書が正当であるかどうかを検証するかどうかです。

可能な値:
0 - (default) 検証しない;
1 - 検証する。

Property behavior:
- type が "HTTP agent" に設定されている場合はサポート対象
- 継承されたオブジェクトまたは発見されたオブジェクトでは読み取り専用

HTTPヘッダー

ヘッダーオブジェクトには、以下のプロパティがあります。

プロパティ Type 説明
name string HTTPヘッダー名。

プロパティの動作:
- 必須
value string ヘッダー値。

プロパティの動作:
- 必須

HTTPクエリフィールド

クエリフィールドオブジェクトは、URLパラメータを指定するために使用される名前と値を定義します。 このオブジェクトには、以下のプロパティがあります。

プロパティ 説明
name string パラメータの名前。

プロパティの動作:
- 必須
value string パラメータの値。

プロパティの動作:
- 必須

アイテムタグ

アイテムタグオブジェクトには、以下のプロパティがあります。

プロパティ 説明
tag string アイテムタグ名。

プロパティの動作:
- 必須
value string アイテムタグの値。

プロパティの動作:
- 読み取り専用
object integer タグの継承元オブジェクトのタイプ。

指定可能な値:
0 - テンプレート;
1 - ホスト。

プロパティの動作:
- 読み取り専用
objectid ID タグの継承元オブジェクトのID。

プロパティの動作:
- 読み取り専用

アイテムの前処理

アイテムの前処理オブジェクトには、以下のプロパティがあります。

Property Type Description
type integer 前処理オプションのタイプ。

指定可能な値:
1 - カスタム乗数;
2 - 右トリム;
3 - 左トリム;
4 - トリム;
5 - 正規表現;
6 - 真偽値から10進数;
7 - 8進数から10進数;
8 - 16進数から10進数;
9 - 単純変化;
10 - 秒あたりの変化;
11 - XML XPath;
12 - JSONPath;
13 - 範囲内;
14 - 正規表現に一致;
15 - 正規表現に一致しない;
16 - JSON内のエラーをチェック;
17 - XML内のエラーをチェック;
18 - 正規表現を使用してエラーをチェック;
19 - 未変更を破棄;
20 - ハートビート付きで未変更を破棄;
21 - JavaScript;
22 - Prometheusパターン;
23 - PrometheusからJSON;
24 - CSVからJSON;
25 - 置換;
26 - 未サポートをチェック;
27 - XMLからJSON;
28 - SNMP walk値;
29 - SNMP walkからJSON;
30 - SNMP get値。

Property behavior:
- required
params string 前処理オプションで使用される追加パラメータ。
複数のパラメータは改行文字 (\n) で区切ります。

type が "Check unsupported" に設定されている場合、パラメータは <scope>[\n<pattern>] 構文に従います。ここで、pattern は正規表現、scope は以下のいずれかです:
-1 - 任意のエラーに一致;
\ 0 - エラーメッセージが pattern に一致するかをチェック;
\ 1 - エラーメッセージが pattern に一致しないかをチェック。

Property behavior:
- type が "Custom multiplier" (1), "Right trim" (2), "Left trim" (3), "Trim" (4), "Regular expression" (5), "XML XPath" (11), "JSONPath" (12), "In range" (13), "Matches regular expression" (14), "Does not match regular expression" (15), "Check for error in JSON" (16), "Check for error in XML" (17), "Check for error using regular expression" (18), "Discard unchanged with heartbeat" (20), "JavaScript" (21), "Prometheus pattern" (22), "Prometheus to JSON" (23), "CSV to JSON" (24), "Replace" (25), Check unsupported (26), "SNMP walk value" (28), "SNMP walk to JSON" (29), または "SNMP get value" (30) に設定されている場合は required
error_handler integer 前処理ステップが失敗した場合に使用されるアクションタイプ。

指定可能な値:
0 - エラーメッセージはZabbix serverによって設定される;
1 - 値を破棄;
2 - カスタム値を設定;
3 - カスタムエラーメッセージを設定。

type が "Check unsupported" に設定されている場合の指定可能な値:
1 - 値を破棄;
2 - カスタム値を設定;
3 - カスタムエラーメッセージを設定。

Property behavior:
- type が "Custom multiplier" (1), "Regular expression" (5), "Boolean to decimal" (6), "Octal to decimal" (7), "Hexadecimal to decimal" (8), "Simple change" (9), "Change per second" (10), "XML XPath" (11), "JSONPath" (12), "In range" (13), "Matches regular expression" (14), "Does not match regular expression" (15), "Check for error in JSON" (16), "Check for error in XML" (17), "Check for error using regular expression" (18), "Prometheus pattern" (22), "Prometheus to JSON" (23), "CSV to JSON" (24), "Check unsupported" (26), "XML to JSON" (27), "SNMP walk value" (28), "SNMP walk to JSON" (29), または "SNMP get value" (30) に設定されている場合は required
error_handler_params string エラーハンドラーのパラメータ。

Property behavior:
- error_handler が "Set custom value" または "Set custom error message" に設定されている場合は required

以下のパラメータおよびエラーハンドラーが、各前処理タイプでサポートされています。

Preprocessing type Name Parameter 1 Parameter 2 Parameter 3 Supported error handlers
1 カスタム乗数 number1, 6 0, 1, 2, 3
2 右トリム 文字のリスト2
3 左トリム 文字のリスト2
4 トリム 文字のリスト2
5 正規表現 pattern3 output2 0, 1, 2, 3
6 真偽値から10進数 0, 1, 2, 3
7 8進数から10進数 0, 1, 2, 3
8 16進数から10進数 0, 1, 2, 3
9 単純変化 0, 1, 2, 3
10 秒あたりの変化 0, 1, 2, 3
11 XML XPath path4 0, 1, 2, 3
12 JSONPath path4 0, 1, 2, 3
13 範囲内 min1, 6 max1, 6 0, 1, 2, 3
14 正規表現に一致 pattern3 0, 1, 2, 3
15 正規表現に一致しない pattern3 0, 1, 2, 3
16 JSON内のエラーをチェック path4 0, 1, 2, 3
17 XML内のエラーをチェック path4 0, 1, 2, 3
18 正規表現を使用してエラーをチェック pattern3 output2 0, 1, 2, 3
19 未変更を破棄
20 ハートビート付きで未変更を破棄 seconds5, 6
21 JavaScript script2
22 Prometheusパターン pattern6, 7 value, label, function output8, 9 0, 1, 2, 3
23 PrometheusからJSON pattern6, 7 0, 1, 2, 3
24 CSVからJSON character2 character2 0,1 0, 1, 2, 3
25 置換 search string2 replacement2
26 未サポートをチェック scope1 pattern3, 6 1, 2, 3
27 XMLからJSON 0, 1, 2, 3
28 SNMP walk値 OID2 形式:
0 - 変更なし
1 - Hex-STRING から UTF-8
2 - Hex-STRING から MAC
3 - BITS から整数
0, 1, 2, 3
29 SNMP walkからJSON10 フィールド名2 OIDプレフィックス2 形式:
0 - 変更なし
1 - Hex-STRING から UTF-8
2 - Hex-STRING から MAC
3 - BITS から整数
0, 1, 2, 3
30 SNMP get値 形式:
1 - Hex-STRING から UTF-8
2 - Hex-STRING から MAC
3 - BITS から整数
0, 1, 2, 3

1 浮動小数点数 (整数は暗黙的に浮動小数点値に変換されます)
2 文字列
3 正規表現
4 JSONPath または XML XPath
5 正の整数 (時間サフィックスをサポート。例: 30s, 1m, 2h, 1d)
6 ユーザーマクロ
7 次の構文に従うPrometheusパターン: <metric name>{<label name>="<label value>", ...} == <value>。 Prometheusパターンの各構成要素 (メトリクス、ラベル名、ラベル値、メトリクス値) にはユーザーマクロを使用できます。
8 次の構文に従うPrometheus出力: 2番目のパラメータとして label が選択されている場合は <label name> (ユーザーマクロ可)。
9 2番目のパラメータとして function が選択されている場合の集計関数のいずれか: sum, min, max, avg, count
10 改行文字で区切られた複数の "Field name,OID prefix,Format records" レコードをサポートします。