Item prototypeオブジェクト

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

アイテムプロトタイプ

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

プロパティ	型	説明
itemid	ID	アイテムプロトタイプのID。プロパティの動作: - 読み取り専用 - 更新操作時に必須
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}` プロパティの動作: - `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。プロパティの動作: - 定数 - 作成操作時に必須
interfaceid	ID	アイテムプロトタイプのホストインターフェースのID。プロパティの動作: - アイテムプロトタイプがホストに属し、`type`が"Zabbix agent"、"IPMI agent"、"JMX agent"、"SNMP trap"、"SNMP agent"の場合に必須 - アイテムプロトタイプがホストに属し、`type`が"Simple check"、"External check"、"SSH agent"、"TELNET agent"、"HTTP agent"の場合にサポート
key_	string	アイテムプロトタイプのキー。プロパティの動作: - 作成操作時に必須 - 継承オブジェクトの場合は読み取り専用
name	string	アイテムプロトタイプの名前。ユーザーマクロをサポート。プロパティの動作: - 作成操作時に必須 - 継承オブジェクトの場合は読み取り専用
type	integer	アイテムプロトタイプのタイプ。指定可能な値: 0 - Zabbix agent; 2 - Zabbix trapper; 3 - Simple check; 5 - Zabbix internal; 7 - Zabbix agent (active); 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。プロパティの動作: - 作成操作時に必須 - 継承オブジェクトの場合は読み取り専用
url	string	URL文字列。 LLDマクロ、ユーザーマクロ、{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{HOST.PORT}、{ITEM.ID}、{ITEM.KEY}をサポート。プロパティの動作: - `type`が"HTTP agent"の場合に必須 - 継承オブジェクトの場合は読み取り専用
value_type	integer	アイテムプロトタイプの情報タイプ。指定可能な値: 0 - 数値(浮動小数点); 1 - 文字列; 2 - ログ; 3 - 数値(整数); 4 - テキスト; 5 - バイナリ。プロパティの動作: - 作成操作時に必須 - 継承オブジェクトの場合は読み取り専用
allow_traps	integer	trapperアイテムと同様に値の受信を許可するか。 0 - (デフォルト) 受信データを許可しない; 1 - 受信データを許可する。プロパティの動作: - `type`が"HTTP agent"の場合にサポート
authtype	integer	認証方式。 `type`が"SSH agent"の場合の指定可能な値: 0 - (デフォルト) パスワード; 1 - 公開鍵。 `type`が"HTTP agent"の場合の指定可能な値: 0 - (デフォルト) なし; 1 - ベーシック; 2 - NTLM; 3 - Kerberos。プロパティの動作: - `type`が"SSH agent"または"HTTP agent"の場合にサポート - 継承オブジェクトの場合は読み取り専用 (`type`が"HTTP agent"の場合)
description	string	アイテムプロトタイプの説明。
flags	integer	アイテムプロトタイプのオリジン。指定可能な値: 2 - アイテムプロトタイプ; 6 - 検出されたアイテムプロトタイププロパティの動作: - 読み取り専用
follow_redirects	integer	データ取得時にレスポンスのリダイレクトを追従するか。指定可能な値: 0 - リダイレクトを追従しない; 1 - (デフォルト) リダイレクトを追従する。プロパティの動作: - `type`が"HTTP agent"の場合にサポート - 継承オブジェクトの場合は読み取り専用
headers	array	HTTPリクエスト実行時に送信されるヘッダーの配列。プロパティの動作: - `type`が"HTTP agent"の場合にサポート - 継承オブジェクトの場合は読み取り専用
history	string	履歴データを保存する期間の時間単位。ユーザーマクロおよびLLDマクロも使用可能。デフォルト: 31d。
http_proxy	string	HTTP(S)プロキシ接続文字列。プロパティの動作: - `type`が"HTTP agent"の場合にサポート - 継承オブジェクトの場合は読み取り専用
ipmi_sensor	string	IPMIセンサー。プロパティの動作: - `type`が"IPMI agent"で`key_`が"ipmi.get"でない場合に必須 - `type`が"IPMI agent"の場合にサポート - 継承オブジェクトの場合は読み取り専用
jmx_endpoint	string	JMXエージェントのカスタム接続文字列。デフォルト: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi プロパティの動作: - `type`が"JMX agent"の場合にサポート
logtimefmt	string	ログエントリの時刻フォーマット。プロパティの動作: - `value_type`が"log"の場合にサポート - 継承オブジェクトの場合は読み取り専用
master_itemid	ID	マスターアイテムのID。プロパティの動作: - `type`が"Dependent item"の場合に必須 - 継承オブジェクトの場合は読み取り専用
output_format	integer	レスポンスをJSONに変換するかどうか。指定可能な値: 0 - (デフォルト) 生データを保存; 1 - JSONに変換。プロパティの動作: - `type`が"HTTP agent"の場合にサポート - 継承オブジェクトの場合は読み取り専用
params	string	アイテムプロトタイプのタイプに応じた追加パラメータ: - SSH agentおよびTELNET agentアイテムプロトタイプの場合は実行スクリプト; - database monitorアイテムプロトタイプの場合はSQLクエリ; - calculatedアイテムプロトタイプの場合は計算式; - scriptおよびbrowserアイテムプロトタイプの場合はスクリプト。プロパティの動作: - `type`が"Database monitor"、"SSH agent"、"TELNET agent"、"Calculated"、"Script"、"Browser"の場合に必須 - 継承オブジェクトの場合は読み取り専用 (`type`が"Script"または"Browser"の場合)
parameters	object/array	`type`が"Script"または"Browser"の場合の追加パラメータ。`name`と`value`プロパティを持つオブジェクトの配列で、`name`は一意でなければなりません。プロパティの動作: - `type`が"Script"または"Browser"の場合にサポート - 継承オブジェクトの場合は読み取り専用
password	string	認証用パスワード。プロパティの動作: - `type`が"JMX agent"で`username`が設定されている場合に必須 - `type`が"Simple check"、"SSH agent"、"TELNET agent"、"Database monitor"、"HTTP agent"の場合にサポート - 継承オブジェクトの場合は読み取り専用 (`type`が"HTTP agent"の場合)
post_type	integer	`posts`プロパティに格納されるPOSTデータボディのタイプ。指定可能な値: 0 - (デフォルト) 生データ。 2 - JSONデータ。 3 - XMLデータ。プロパティの動作: - `type`が"HTTP agent"の場合にサポート - 継承オブジェクトの場合は読み取り専用
posts	string	HTTP(S)リクエストボディデータ。プロパティの動作: - `type`が"HTTP agent"で`post_type`が"JSON data"または"XML data"の場合に必須 - `type`が"HTTP agent"で`post_type`が"Raw data"の場合にサポート - 継承オブジェクトの場合は読み取り専用
privatekey	string	秘密鍵ファイル名。プロパティの動作: - `type`が"SSH agent"で`authtype`が"public key"の場合に必須
publickey	string	公開鍵ファイル名。プロパティの動作: - `type`が"SSH agent"で`authtype`が"public key"の場合に必須
query_fields	array	HTTPリクエスト実行時に送信されるクエリフィールドの配列。プロパティの動作: - `type`が"HTTP agent"の場合にサポート - 継承オブジェクトの場合は読み取り専用
request_method	integer	リクエストメソッドのタイプ。指定可能な値: 0 - (デフォルト) GET; 1 - POST; 2 - PUT; 3 - HEAD。プロパティの動作: - `type`が"HTTP agent"の場合にサポート - 継承オブジェクトの場合は読み取り専用
retrieve_mode	integer	レスポンスのどの部分を保存するか。 `request_method`が"GET"、"POST"、"PUT"の場合の指定可能な値: 0 - (デフォルト) ボディ; 1 - ヘッダー; 2 - ボディとヘッダーの両方を保存。 `request_method`が"HEAD"の場合の指定可能な値: 1 - ヘッダー。プロパティの動作: - `type`が"HTTP agent"の場合にサポート - 継承オブジェクトの場合は読み取り専用
snmp_oid	string	SNMP OID。プロパティの動作: - `type`が"SNMP agent"の場合に必須 - 継承オブジェクトの場合は読み取り専用
ssl_cert_file	string	公開SSLキーのファイルパス。プロパティの動作: - `type`が"HTTP agent"の場合にサポート - 継承オブジェクトの場合は読み取り専用
ssl_key_file	string	秘密SSLキーのファイルパス。プロパティの動作: - `type`が"HTTP agent"の場合にサポート - 継承オブジェクトの場合は読み取り専用
ssl_key_password	string	SSLキーのパスワード。プロパティの動作: - `type`が"HTTP agent"の場合にサポート - 継承オブジェクトの場合は読み取り専用
status	integer	アイテムプロトタイプのステータス。指定可能な値: 0 - (デフォルト) 有効なアイテムプロトタイプ; 1 - 無効なアイテムプロトタイプ; 3 - サポートされていないアイテムプロトタイプ。
status_codes	string	カンマ区切りの必要なHTTPステータスコードの範囲。カンマ区切りリストの一部としてユーザーマクロまたはLLDマクロもサポート。例: 200,200-{$M},{$M},200-400 プロパティの動作: - `type`が"HTTP agent"の場合にサポート - 継承オブジェクトの場合は読み取り専用
templateid	ID	親テンプレートアイテムプロトタイプのID。プロパティの動作: - 読み取り専用
timeout	string	アイテムデータ取得リクエストのタイムアウト。秒またはサフィックス付きの時間単位(例: 30s, 1m)を指定可能。ユーザーマクロおよびLLDマクロも使用可能。指定可能な値の範囲: 1-600s。デフォルト: "" - プロキシ/グローバル設定を使用。プロパティの動作: - `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	許可されたホスト。プロパティの動作: - `type`が"Zabbix trapper"の場合、または`type`が"HTTP agent"で`allow_traps`が"Allow to accept incoming data"の場合にサポート
trends	string	トレンドデータを保存する期間の時間単位。ユーザーマクロおよびLLDマクロも使用可能。デフォルト: 365d。プロパティの動作: - `value_type`が"numeric float"または"numeric unsigned"の場合にサポート
units	string	値の単位。プロパティの動作: - `value_type`が"numeric float"または"numeric unsigned"の場合にサポート - 継承オブジェクトの場合は読み取り専用
username	string	認証用ユーザー名。プロパティの動作: - `type`が"SSH agent"または"TELNET agent"の場合、または`type`が"JMX agent"で`password`が設定されている場合に必須 - `type`が"Simple check"、"Database monitor"、"HTTP agent"の場合にサポート - 継承オブジェクトの場合は読み取り専用 (`type`が"HTTP agent"の場合)
uuid	string	インポートされたアイテムプロトタイプを既存のものにリンクするためのユニバーサル一意識別子。指定しない場合は自動生成。プロパティの動作: - アイテムプロトタイプがテンプレートに属する場合にサポート
valuemapid	ID	関連付けられた値のマップのID。プロパティの動作: - `value_type`が"numeric float"、"character"、"numeric unsigned"の場合にサポート - 継承オブジェクトの場合は読み取り専用
verify_host	integer	接続先のホスト名が証明書のホスト名と一致するか検証するかどうか。指定可能な値: 0 - (デフォルト) 検証しない; 1 - 検証する。プロパティの動作: - `type`が"HTTP agent"の場合にサポート - 継承オブジェクトの場合は読み取り専用
verify_peer	integer	ホストの証明書が正当かどうか検証するかどうか。指定可能な値: 0 - (デフォルト) 検証しない; 1 - 検証する。プロパティの動作: - `type`が"HTTP agent"の場合にサポート - 継承オブジェクトの場合は読み取り専用
discover	integer	アイテムプロトタイプのディスカバリーステータス。指定可能な値: 0 - (デフォルト) 新しいアイテムをディスカバリーする; 1 - 新しいアイテムをディスカバリーせず、既存のアイテムをロストとしてマークする。

HTTP header

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

プロパティ	タイプ	説明
name	文字列	HTTP ヘッダー名プロパティの動作: - 必須
value	文字列	ヘッダー値プロパティの動作: - 必須

HTTP query field

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

プロパティ	タイプ	説明
name	文字列	パラメータ名プロパティの動作: - 必須
value	文字列	パラメータ値プロパティの動作: - 必須

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

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

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

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

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

プロパティ	タイプ	説明
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値。プロパティの動作: - 必須
params	string	事前処理オプションで使用される追加パラメータ。複数のパラメータは改行（\n）で区切ります。 `type`が「サポート外判定」に設定されている場合、パラメータは`<scope>[\n<pattern>]`の構文に従います。patternは正規表現、scopeは以下のいずれかです： -1 - すべてのエラーに一致; 0 - エラーメッセージがpatternに一致するか判定; 1 - エラーメッセージがpatternに一致しないか判定。プロパティの動作: - `type`が「カスタム乗数」(1)、「右側トリム」(2)、「左側トリム」(3)、「トリム」(4)、「正規表現」(5)、「XML XPath」(11)、「JSONPath」(12)、「範囲内判定」(13)、「正規表現に一致」(14)、「正規表現に一致しない」(15)、「JSONのエラー判定」(16)、「XMLのエラー判定」(17)、「正規表現によるエラー判定」(18)、「ハートビート付き変化なしを破棄」(20)、「JavaScript」(21)、「Prometheusパターン」(22)、「PrometheusをJSONに変換」(23)、「CSVをJSONに変換」(24)、「置換」(25)、「サポート外判定」(26)、「SNMP walk値」(28)、「SNMP walkをJSONに変換」(29)、「SNMP get値」(30)の場合は必須
error_handler	integer	事前処理ステップが失敗した場合に使用されるアクションタイプ。指定可能な値： 0 - Zabbixサーバーがエラーメッセージを設定; 1 - 値を破棄; 2 - カスタム値を設定; 3 - カスタムエラーメッセージを設定。 `type`が「サポート外判定」に設定されている場合の指定可能な値： 1 - 値を破棄; 2 - カスタム値を設定; 3 - カスタムエラーメッセージを設定。プロパティの動作: - `type`が「カスタム乗数」(1)、「正規表現」(5)、「ブール値を10進数に変換」(6)、「8進数を10進数に変換」(7)、「16進数を10進数に変換」(8)、「単純な変化量」(9)、「秒あたりの変化量」(10)、「XML XPath」(11)、「JSONPath」(12)、「範囲内判定」(13)、「正規表現に一致」(14)、「正規表現に一致しない」(15)、「JSONのエラー判定」(16)、「XMLのエラー判定」(17)、「正規表現によるエラー判定」(18)、「Prometheusパターン」(22)、「PrometheusをJSONに変換」(23)、「CSVをJSONに変換」(24)、「サポート外判定」(26)、「XMLをJSONに変換」(27)、「SNMP walk値」(28)、「SNMP walkをJSONに変換」(29)、「SNMP get値」(30)の場合は必須
error_handler_params	string	エラーハンドラのパラメータ。プロパティの動作: - `error_handler`が「カスタム値を設定」または「カスタムエラーメッセージを設定」の場合は必須

各事前処理タイプでサポートされるパラメータとエラーハンドラは以下の通りです。

事前処理タイプ	名前	パラメータ1	パラメータ2	パラメータ3	サポートされるエラーハンドラ
1	カスタム乗数	数値^1, 6			0, 1, 2, 3
2	右側トリム	文字列リスト²
3	左側トリム	文字列リスト²
4	トリム	文字列リスト²
5	正規表現	パターン³	出力²		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	パス⁴			0, 1, 2, 3
12	JSONPath	パス⁴			0, 1, 2, 3
13	範囲内判定	min^1, 6	max^1, 6		0, 1, 2, 3
14	正規表現に一致	パターン³			0, 1, 2, 3
15	正規表現に一致しない	パターン³			0, 1, 2, 3
16	JSONのエラー判定	パス⁴			0, 1, 2, 3
17	XMLのエラー判定	パス⁴			0, 1, 2, 3
18	正規表現によるエラー判定	パターン³	出力²		0, 1, 2, 3
19	変化なしを破棄
20	ハートビート付き変化なしを破棄	秒数^5, 6
21	JavaScript	スクリプト²
22	Prometheusパターン	パターン^6, 7	`value`, `label`, `function`	出力^8, 9	0, 1, 2, 3
23	PrometheusをJSONに変換	パターン^6, 7			0, 1, 2, 3
24	CSVをJSONに変換	文字²	文字²	0,1	0, 1, 2, 3
25	置換	検索文字列²	置換文字列²
26	サポート外判定	スコープ¹	パターン^3, 6		1, 2, 3
27	XMLをJSONに変換				0, 1, 2, 3
28	SNMP walk値	OID²	フォーマット: 0 - 変更なし 1 - Hex-STRINGからUTF-8 2 - Hex-STRINGからMAC 3 - BITSから整数		0, 1, 2, 3
29	SNMP walkをJSONに変換¹⁰	フィールド名²	OIDプレフィックス²	フォーマット: 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

¹ 整数または浮動小数点数
² 文字列
³ 正規表現
⁴ JSONPathまたはXML XPath
⁵ 正の整数（時間のサフィックス指定可。例：30s, 1m, 2h, 1d）
⁶ ユーザーマクロ、LLDマクロ
⁷ Prometheusパターン。構文は<metric name>{<label name>="<label value>", ...} == <value>。各Prometheusパターン要素（メトリック、ラベル名、ラベル値、メトリック値）はユーザーマクロまたはLLDマクロにできます。
⁸ Prometheus出力。構文は<label name>（ユーザーマクロまたはLLDマクロ可）。2番目のパラメータがlabelの場合。
⁹ 集約関数のいずれか：sum, min, max, avg, count。2番目のパラメータがfunctionの場合。
¹⁰ 複数の「フィールド名,OIDプレフィックス,フォーマット」レコードを改行で区切って指定可能。

Documentation