Item prototypeオブジェクト

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

アイテムのプロトタイプ

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

Property Type Description
itemid ID アイテムのプロトタイプのID。

Property behavior:
- read-only
- 更新操作で required
delay string アイテムのプロトタイプの更新間隔。

秒、またはサフィックス付きの時間単位（例: 30s、1m、2h、1d）を受け付け、必要に応じて、セミコロンで区切られた1つ以上のカスタム間隔も指定できます。カスタム間隔には、柔軟な間隔とスケジューリング間隔を混在させることができます。

ユーザーマクロおよびLLDマクロを受け付けます。使用する場合、値は単一のマクロでなければなりません。複数のマクロ、またはテキストと混在したマクロはサポートされません。柔軟な間隔は、スラッシュで区切られた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" が含まれない場合は required
hostid ID このアイテムのプロトタイプが属するホストのID。

Property behavior:
- constant
- 作成操作で required
interfaceid ID アイテムのプロトタイプのホストインターフェースのID。

Property behavior:
- アイテムのプロトタイプがホストに属し、type が "Zabbix agent"、"IPMI agent"、"JMX agent"、"SNMP trap"、または "SNMP agent" に設定されている場合は required
- アイテムのプロトタイプがホストに属し、type が "Simple check"、"External check"、"SSH agent"、"TELNET agent"、または "HTTP agent" に設定されている場合は supported
key_ string アイテムのプロトタイプキー。

Property behavior:
- 作成操作で required
- 継承オブジェクトでは read-only
name string アイテムのプロトタイプ名。
ユーザーマクロをサポートします。

Property behavior:
- 作成操作で required
- 継承オブジェクトでは read-only
type integer アイテムのプロトタイプのタイプ。

指定可能な値:
0 - Zabbix エージェント;
2 - Zabbix trapper;
3 - Simple check;
5 - Zabbix internal;
7 - Zabbix エージェント (active);
10 - External check;
11 - Database monitor;
12 - IPMI エージェント;
13 - SSH エージェント;
14 - TELNET エージェント;
15 - Calculated;
16 - JMX エージェント;
17 - SNMP trap;
18 - 依存アイテム;
19 - HTTP エージェント;
20 - SNMP エージェント;
21 - Script;
22 - Browser。

Property behavior:
- 作成操作で required
- 継承オブジェクトでは read-only
url string URL文字列。
LLDマクロ、ユーザーマクロ、{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{ITEM.ID}、{ITEM.KEY} をサポートします。

Property behavior:
- type が "HTTP agent" に設定されている場合は required
- 継承オブジェクトでは read-only
value_type integer アイテムのプロトタイプの情報タイプ。

指定可能な値:
0 - 数値（浮動小数）;
1 - 文字列;
2 - ログ;
3 - 数値（符号なし）;
4 - テキスト;
5 - バイナリ。

Property behavior:
- 作成操作で required
- 継承オブジェクトでは read-only
allow_traps integer trapperアイテムと同様に値の投入を許可します。

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

Property behavior:
- type が "HTTP agent" に設定されている場合は supported
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" に設定されている場合は supported
- 継承オブジェクトでは read-only（type が "HTTP agent" に設定されている場合）
description string アイテムのプロトタイプの説明。
follow_redirects integer データ取得時にレスポンスのリダイレクトに従います。

指定可能な値:
0 - リダイレクトに従わない;
1 - (default) リダイレクトに従う。

Property behavior:
- type が "HTTP agent" に設定されている場合は supported
- 継承オブジェクトでは read-only
headers array HTTPリクエスト実行時に送信されるヘッダーの配列。

Property behavior:
- type が "HTTP agent" に設定されている場合は supported
- 継承オブジェクトでは read-only
history string 履歴データを保存する期間を表す時間単位。
ユーザーマクロおよびLLDマクロも受け付けます。

デフォルト: 31d。
http_proxy string HTTP(S) プロキシ接続文字列。

Property behavior:
- type が "HTTP agent" に設定されている場合は supported
- 継承オブジェクトでは read-only
ipmi_sensor string IPMIセンサー。

Property behavior:
- type が "IPMI agent" に設定され、key_ が "ipmi.get" に設定されていない場合は required
- type が "IPMI agent" に設定されている場合は supported
- 継承オブジェクトでは read-only
jmx_endpoint string JMX エージェントのカスタム接続文字列。

デフォルト: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi

Property behavior:
- type が "JMX agent" に設定されている場合は supported
logtimefmt string ログエントリ内の時刻の形式。

Property behavior:
- value_type が "log" に設定されている場合は supported
- 継承オブジェクトでは read-only
master_itemid ID マスターアイテムのID。
依存アイテムおよびアイテムのプロトタイプは最大3階層までの再帰が許可され、依存アイテムおよびアイテムのプロトタイプの最大数は 29999 です。

Property behavior:
- type が "Dependent item" に設定されている場合は required
- 継承オブジェクトでは read-only
output_format integer レスポンスをJSONに変換するかどうか。

指定可能な値:
0 - (default) 生データのまま保存;
1 - JSONに変換。

Property behavior:
- type が "HTTP agent" に設定されている場合は supported
- 継承オブジェクトでは read-only
params string アイテムのプロトタイプのタイプに応じた追加パラメータ:
- SSH エージェントおよび TELNET エージェントのアイテムのプロトタイプでは実行スクリプト;
- Database monitor のアイテムのプロトタイプではSQLクエリ;
- Calculated のアイテムのプロトタイプでは数式;
- Script および Browser のアイテムのプロトタイプではスクリプト。

Property behavior:
- type が "Database monitor"、"SSH agent"、"TELNET agent"、"Calculated"、"Script"、または "Browser" に設定されている場合は required
- 継承オブジェクトでは read-only（type が "Script" または "Browser" に設定されている場合）
parameters object/array type が "Script" または "Browser" に設定されている場合の追加パラメータ。name および value プロパティを持つオブジェクトの配列で、name は一意である必要があります。

Property behavior:
- type が "Script" または "Browser" に設定されている場合は supported
- 継承オブジェクトでは read-only
password string 認証用パスワード。

Property behavior:
- type が "JMX agent" に設定され、username が設定されている場合は required
- type が "Simple check"、"SSH agent"、"TELNET agent"、"Database monitor"、または "HTTP agent" に設定されている場合は supported
- 継承オブジェクトでは read-only（type が "HTTP agent" に設定されている場合）
post_type integer posts プロパティに保存されるPOSTデータ本文のタイプ。

指定可能な値:
0 - (default) 生データ。
2 - JSONデータ。
3 - XMLデータ。

Property behavior:
- type が "HTTP agent" に設定されている場合は supported
- 継承オブジェクトでは read-only
posts string HTTP(S) リクエスト本文データ。

Property behavior:
- type が "HTTP agent" に設定され、post_type が "JSON data" または "XML data" に設定されている場合は required
- type が "HTTP agent" に設定され、post_type が "Raw data" に設定されている場合は supported
- 継承オブジェクトでは read-only
privatekey string 秘密鍵ファイル名。

Property behavior:
- type が "SSH agent" に設定され、authtype が "public key" に設定されている場合は required
publickey string 公開鍵ファイル名。

Property behavior:
- type が "SSH agent" に設定され、authtype が "public key" に設定されている場合は required
query_fields array HTTPリクエスト実行時に送信されるクエリフィールドの配列。

Property behavior:
- type が "HTTP agent" に設定されている場合は supported
- 継承オブジェクトでは read-only
request_method integer リクエストメソッドのタイプ。

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

Property behavior:
- type が "HTTP agent" に設定されている場合は supported
- 継承オブジェクトでは read-only
retrieve_mode integer レスポンスのどの部分を保存するか。

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

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

Property behavior:
- type が "HTTP agent" に設定されている場合は supported
- 継承オブジェクトでは read-only
snmp_oid string SNMP OID。

Property behavior:
- type が "SNMP agent" に設定されている場合は required
- 継承オブジェクトでは read-only
ssl_cert_file string 公開SSL鍵ファイルのパス。

Property behavior:
- type が "HTTP agent" に設定されている場合は supported
- 継承オブジェクトでは read-only
ssl_key_file string 秘密SSL鍵ファイルのパス。

Property behavior:
- type が "HTTP agent" に設定されている場合は supported
- 継承オブジェクトでは read-only
ssl_key_password string SSL鍵ファイルのパスワード。

Property behavior:
- type が "HTTP agent" に設定されている場合は supported
- 継承オブジェクトでは read-only
status integer アイテムのプロトタイプのステータス。

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

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

Property behavior:
- type が "HTTP agent" に設定されている場合は supported
- 継承オブジェクトでは read-only
templateid ID 親テンプレートのアイテムのプロトタイプID。

Property behavior:
- read-only
timeout string アイテムデータ取得リクエストのタイムアウト。
秒、またはサフィックス付きの時間単位（例: 30s、1m）を受け付けます。ユーザーマクロおよびLLDマクロも受け付けます。

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

デフォルト: "" - プロキシ/グローバル設定を使用。

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) に設定されている場合は supported
- 継承オブジェクトでは read-only
trapper_hosts string 許可されたホスト。

Property behavior:
- type が "Zabbix trapper" に設定されている場合、または type が "HTTP agent" に設定され、allow_traps が "Allow to accept incoming data" に設定されている場合は supported
trends string トレンドデータを保存する期間を表す時間単位。
ユーザーマクロおよびLLDマクロも受け付けます。

デフォルト: 365d。

Property behavior:
- value_type が "numeric float" または "numeric unsigned" に設定されている場合は supported
units string 値の単位。

Property behavior:
- value_type が "numeric float" または "numeric unsigned" に設定されている場合は supported
- 継承オブジェクトでは read-only
username string 認証用ユーザー名。

Property behavior:
- type が "SSH agent" または "TELNET agent" に設定されている場合、または type が "JMX agent" に設定され、password が設定されている場合は required
- type が "Simple check"、"Database monitor"、または "HTTP agent" に設定されている場合は supported
- 継承オブジェクトでは read-only（type が "HTTP agent" に設定されている場合）
uuid string 既存のアイテムのプロトタイプにインポートしたアイテムのプロトタイプを関連付けるために使用される汎用一意識別子。指定しない場合は自動生成されます。

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

Property behavior:
- value_type が "numeric float"、"character"、または "numeric unsigned" に設定されている場合は supported
- 継承オブジェクトでは read-only
verify_host integer 接続先のホスト名がホスト証明書内の名前と一致することを検証するかどうか。

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

Property behavior:
- type が "HTTP agent" に設定されている場合は supported
- 継承オブジェクトでは read-only
verify_peer integer ホスト証明書が正当であることを検証するかどうか。

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

Property behavior:
- type が "HTTP agent" に設定されている場合は supported
- 継承オブジェクトでは read-only
discover integer アイテムのプロトタイプのディスカバリステータス。

指定可能な値:
0 - (default) 新しいアイテムがディスカバリされる;
1 - 新しいアイテムはディスカバリされず、既存のアイテムは失われたものとしてマークされる。

HTTPヘッダー

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

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

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

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

HTTPクエリフィールド

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

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

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

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

アイテムプロトタイプタグ

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

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

Property behavior:
- required
value string アイテムプロトタイプのタグ値。

アイテムプロトタイプの前処理

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

プロパティ Type 説明
type integer 前処理オプションのタイプ。

指定可能な値:
1 - カスタム乗数;
2 - 右トリム;
3 - 左トリム;
4 - トリム;
5 - 正規表現;
6 - 真偽値から10進数;
7 - 8進数から10進数;
8 - 16進数から10進数;
9 - 単純変化;
10 - 1秒あたりの変化;
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サーバーによって設定される;
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

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

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