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エージェント"(0)、"シンプルチェック"(3)、"Zabbixインターナル"(5)、"外部チェック"(10)、"データベース監視"(11)、"IPMIエージェント"(12)、"SSHエージェント"(13)、"TELNETエージェント"(14)、"計算"(15)、"JMXエージェント"(16)、"HTTPエージェント"(19)、"SNMPエージェント"(20)、"スクリプト"(21)、"ブラウザ"(22)の場合、またはtypeが"Zabbixエージェント（アクティブ）"(7)でkey_に"mqtt.get"が含まれていない場合に必須
hostid ID アイテムプロトタイプが属するホストのID。

プロパティの動作:
- 定数
- 作成操作時に必須
interfaceid ID アイテムプロトタイプのホストインターフェースのID。

プロパティの動作:
- アイテムプロトタイプがホストに属し、typeが"Zabbixエージェント"、"IPMIエージェント"、"JMXエージェント"、"SNMPトラップ"、"SNMPエージェント"の場合に必須
- アイテムプロトタイプがホストに属し、typeが"シンプルチェック"、"外部チェック"、"SSHエージェント"、"TELNETエージェント"、"HTTPエージェント"の場合にサポート
key_ string アイテムプロトタイプのキー。

プロパティの動作:
- 作成操作時に必須
- 継承オブジェクトの場合は読み取り専用
name string アイテムプロトタイプの名前。
ユーザーマクロをサポート。

プロパティの動作:
- 作成操作時に必須
- 継承オブジェクトの場合は読み取り専用
type integer アイテムプロトタイプのタイプ。

指定可能な値：
0 - Zabbixエージェント;
2 - Zabbixトラッパー;
3 - シンプルチェック;
5 - Zabbixインターナル;
7 - Zabbixエージェント（アクティブ）;
10 - 外部チェック;
11 - データベース監視;
12 - IPMIエージェント;
13 - SSHエージェント;
14 - TELNETエージェント;
15 - 計算;
16 - JMXエージェント;
17 - SNMPトラップ;
18 - 依存アイテム;
19 - HTTPエージェント;
20 - SNMPエージェント;
21 - スクリプト;
22 - ブラウザ。

プロパティの動作:
- 作成操作時に必須
- 継承オブジェクトの場合は読み取り専用
url string URL文字列。
LLDマクロ、ユーザーマクロ、{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{HOST.PORT}、{ITEM.ID}、{ITEM.KEY}をサポート。

プロパティの動作:
- typeが"HTTPエージェント"の場合に必須
- 継承オブジェクトの場合は読み取り専用
value_type integer アイテムプロトタイプの情報タイプ。

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

プロパティの動作:
- 作成操作時に必須
- 継承オブジェクトの場合は読み取り専用
allow_traps integer トラッパーアイテムと同様に値の受信を許可するかどうか。

0 - (デフォルト) 受信データを許可しない;
1 - 受信データを許可する。

プロパティの動作:
- typeが"HTTPエージェント"の場合にサポート
authtype integer 認証方式。

typeが"SSHエージェント"の場合の指定可能な値：
0 - (デフォルト) パスワード;
1 - 公開鍵。

typeが"HTTPエージェント"の場合の指定可能な値：
0 - (デフォルト) なし;
1 - ベーシック;
2 - NTLM;
3 - Kerberos;
4 - ダイジェスト。

プロパティの動作:
- typeが"SSHエージェント"または"HTTPエージェント"の場合にサポート
- 継承オブジェクトの場合は読み取り専用（typeが"HTTPエージェント"の場合）
description string アイテムプロトタイプの説明。
flags integer アイテムプロトタイプの由来。

指定可能な値：
2 - アイテムプロトタイプ;
6 - 検出されたアイテムプロトタイプ

プロパティの動作:
- 読み取り専用
follow_redirects integer データ取得時にレスポンスのリダイレクトを追従するかどうか。

指定可能な値：
0 - リダイレクトを追従しない;
1 - (デフォルト) リダイレクトを追従する。

プロパティの動作:
- typeが"HTTPエージェント"の場合にサポート
- 継承オブジェクトの場合は読み取り専用
headers array HTTPリクエスト実行時に送信されるヘッダーの配列。

プロパティの動作:
- typeが"HTTPエージェント"の場合にサポート
- 継承オブジェクトの場合は読み取り専用
history string 履歴データを保存する期間の単位。
ユーザーマクロおよびLLDマクロも使用可能。

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

プロパティの動作:
- typeが"HTTPエージェント"の場合にサポート
- 継承オブジェクトの場合は読み取り専用
ipmi_sensor string IPMIセンサー。

プロパティの動作:
- typeが"IPMIエージェント"でkey_が"ipmi.get"でない場合に必須
- typeが"IPMIエージェント"の場合にサポート
- 継承オブジェクトの場合は読み取り専用
jmx_endpoint string JMXエージェントのカスタム接続文字列。

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

プロパティの動作:
- typeが"JMXエージェント"の場合にサポート
logtimefmt string ログエントリ内の時刻のフォーマット。

プロパティの動作:
- value_typeが"log"の場合にサポート
- 継承オブジェクトの場合は読み取り専用
master_itemid ID マスターアイテムのID。

プロパティの動作:
- typeが"依存アイテム"の場合に必須
- 継承オブジェクトの場合は読み取り専用
output_format integer レスポンスをJSONに変換するかどうか。

指定可能な値：
0 - (デフォルト) 生データを保存;
1 - JSONに変換。

プロパティの動作:
- typeが"HTTPエージェント"の場合にサポート
- 継承オブジェクトの場合は読み取り専用
params string アイテムプロトタイプのタイプに応じた追加パラメータ：
- SSHエージェントおよびTELNETエージェントアイテムプロトタイプの場合は実行スクリプト;
- データベース監視アイテムプロトタイプの場合はSQLクエリ;
- 計算アイテムプロトタイプの場合は計算式;
- スクリプトおよびブラウザアイテムプロトタイプの場合はスクリプト。

プロパティの動作:
- typeが"データベース監視"、"SSHエージェント"、"TELNETエージェント"、"計算"、"スクリプト"、"ブラウザ"の場合に必須
- 継承オブジェクトの場合は読み取り専用（typeが"スクリプト"または"ブラウザ"の場合）
parameters object/array typeが"スクリプト"または"ブラウザ"の場合の追加パラメータ。nameとvalueプロパティを持つオブジェクトの配列で、nameは一意でなければなりません。

プロパティの動作:
- typeが"スクリプト"または"ブラウザ"の場合にサポート
- 継承オブジェクトの場合は読み取り専用
password string 認証用パスワード。

プロパティの動作:
- typeが"JMXエージェント"でusernameが設定されている場合に必須
- typeが"シンプルチェック"、"SSHエージェント"、"TELNETエージェント"、"データベース監視"、"HTTPエージェント"の場合にサポート
- 継承オブジェクトの場合は読み取り専用（typeが"HTTPエージェント"の場合）
post_type integer postsプロパティに格納されるPOSTデータ本体のタイプ。

指定可能な値：
0 - (デフォルト) 生データ。
2 - JSONデータ。
3 - XMLデータ。

プロパティの動作:
- typeが"HTTPエージェント"の場合にサポート
- 継承オブジェクトの場合は読み取り専用
posts string HTTP(S)リクエストボディデータ。

プロパティの動作:
- typeが"HTTPエージェント"でpost_typeが"JSONデータ"または"XMLデータ"の場合に必須
- typeが"HTTPエージェント"でpost_typeが"生データ"の場合にサポート
- 継承オブジェクトの場合は読み取り専用
privatekey string 秘密鍵ファイル名。

プロパティの動作:
- typeが"SSHエージェント"でauthtypeが"公開鍵"の場合に必須
publickey string 公開鍵ファイル名。

プロパティの動作:
- typeが"SSHエージェント"でauthtypeが"公開鍵"の場合に必須
query_fields array HTTPリクエスト実行時に送信されるクエリフィールドの配列。

プロパティの動作:
- typeが"HTTPエージェント"の場合にサポート
- 継承オブジェクトの場合は読み取り専用
request_method integer リクエストメソッドのタイプ。

指定可能な値：
0 - (デフォルト) GET;
1 - POST;
2 - PUT;
3 - HEAD。

プロパティの動作:
- typeが"HTTPエージェント"の場合にサポート
- 継承オブジェクトの場合は読み取り専用
retrieve_mode integer レスポンスのどの部分を保存するか。

request_methodが"GET"、"POST"、"PUT"の場合の指定可能な値：
0 - (デフォルト) 本文;
1 - ヘッダー;
2 - 本文とヘッダーの両方を保存。

request_methodが"HEAD"の場合の指定可能な値：
1 - ヘッダー。

プロパティの動作:
- typeが"HTTPエージェント"の場合にサポート
- 継承オブジェクトの場合は読み取り専用
snmp_oid string SNMP OID。

プロパティの動作:
- typeが"SNMPエージェント"の場合に必須
- 継承オブジェクトの場合は読み取り専用
ssl_cert_file string 公開SSLキーのファイルパス。

プロパティの動作:
- typeが"HTTPエージェント"の場合にサポート
- 継承オブジェクトの場合は読み取り専用
ssl_key_file string 秘密SSLキーのファイルパス。

プロパティの動作:
- typeが"HTTPエージェント"の場合にサポート
- 継承オブジェクトの場合は読み取り専用
ssl_key_password string SSLキーのパスワード。

プロパティの動作:
- typeが"HTTPエージェント"の場合にサポート
- 継承オブジェクトの場合は読み取り専用
status integer アイテムプロトタイプのステータス。

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

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

プロパティの動作:
- typeが"HTTPエージェント"の場合にサポート
- 継承オブジェクトの場合は読み取り専用
templateid ID 親テンプレートアイテムプロトタイプのID。

プロパティの動作:
- 読み取り専用
timeout string アイテムデータ取得リクエストのタイムアウト。
秒または単位付きの時間（例：30s、1m）を指定可能。ユーザーマクロおよびLLDマクロも使用可能。

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

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

プロパティの動作:
- typeが"Zabbixエージェント"(0)、"シンプルチェック"(3)でkey_が"vmware."または"icmpping"で始まらない場合、"Zabbixエージェント（アクティブ）"(7)、"外部チェック"(10)、"データベース監視"(11)、"SSHエージェント"(13)、"TELNETエージェント"(14)、"HTTPエージェント"(19)、"SNMPエージェント"(20)でsnmp_oidが"walk["または"get["で始まる場合、"スクリプト"(21)、"ブラウザ"(22)の場合にサポート
- 継承オブジェクトの場合は読み取り専用
trapper_hosts string 許可されたホスト。

プロパティの動作:
- typeが"Zabbixトラッパー"、またはtypeが"HTTPエージェント"でallow_trapsが"受信データを許可する"の場合にサポート
trends string トレンドデータを保存する期間の単位。
ユーザーマクロおよびLLDマクロも使用可能。

デフォルト：365d。

プロパティの動作:
- value_typeが"数値（浮動小数点）"または"数値（符号なし）"の場合にサポート
units string 値の単位。

プロパティの動作:
- value_typeが"数値（浮動小数点）"または"数値（符号なし）"の場合にサポート
- 継承オブジェクトの場合は読み取り専用
username string 認証用ユーザー名。

プロパティの動作:
- typeが"SSHエージェント"または"TELNETエージェント"の場合、またはtypeが"JMXエージェント"でpasswordが設定されている場合に必須
- typeが"シンプルチェック"、"データベース監視"、"HTTPエージェント"の場合にサポート
- 継承オブジェクトの場合は読み取り専用（typeが"HTTPエージェント"の場合）
uuid string インポートされたアイテムプロトタイプを既存のものにリンクするためのユニバーサル一意識別子。指定しない場合は自動生成。

プロパティの動作:
- アイテムプロトタイプがテンプレートに属する場合にサポート
valuemapid ID 関連付けられた値のマップのID。

プロパティの動作:
- value_typeが"数値（浮動小数点）"、"文字列"、"数値（符号なし）"の場合にサポート
- 継承オブジェクトの場合は読み取り専用
verify_host integer 接続先のホスト名が証明書のホスト名と一致するか検証するかどうか。

指定可能な値：
0 - (デフォルト) 検証しない;
1 - 検証する。

プロパティの動作:
- typeが"HTTPエージェント"の場合にサポート
- 継承オブジェクトの場合は読み取り専用
verify_peer integer ホストの証明書が正当かどうか検証するかどうか。

指定可能な値：
0 - (デフォルト) 検証しない;
1 - 検証する。

プロパティの動作:
- typeが"HTTPエージェント"の場合にサポート
- 継承オブジェクトの場合は読み取り専用
discover integer アイテムプロトタイプのディスカバリーステータス。

指定可能な値：
0 - (デフォルト) 新しいアイテムがディスカバリーされる;
1 - 新しいアイテムはディスカバリーされず、既存のアイテムはロストとしてマークされる。

HTTP header

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

プロパティ タイプ 説明
name 文字列 HTTP ヘッダー名

プロパティの動作:
- 必須
value 文字列 ヘッダー値

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

HTTP query field

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

プロパティ タイプ 説明
name 文字列 パラメータ名

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

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

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

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

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

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

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

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

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

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

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

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

プロパティ タイプ 説明
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 カスタム乗数 number1,\ 6 0, 1, 2, 3
2 右側トリム 文字リスト2
3 左側トリム 文字リスト2
4 トリム 文字リスト2
5 正規表現 パターン3 出力2 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 パス4 0, 1, 2, 3
12 JSONPath パス4 0, 1, 2, 3
13 範囲内判定 min1,\ 6 max1,\ 6 0, 1, 2, 3
14 正規表現に一致 パターン3 0, 1, 2, 3
15 正規表現に一致しない パターン3 0, 1, 2, 3
16 JSONのエラー判定 パス4 0, 1, 2, 3
17 XMLのエラー判定 パス4 0, 1, 2, 3
18 正規表現によるエラー判定 パターン3 出力2 0, 1, 2, 3
19 変化なしを破棄
20 ハートビート付き変化なしを破棄 秒数5,\ 6
21 JavaScript スクリプト2
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に変換 文字2 文字2 0,1 0, 1, 2, 3
25 置換 検索文字列2 置換文字列2
26 サポート外判定 scope1 パターン3,\ 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をJSONに変換10 フィールド名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 ユーザーマクロ、LLDマクロ
7 Prometheusパターンは<metric name>{<label name>="<label value>", ...} == <value>構文に従います。各Prometheusパターン要素(メトリック、ラベル名、ラベル値、メトリック値)はユーザーマクロまたはLLDマクロにできます。
8 2番目のパラメータにlabelを選択した場合、<label name>(ユーザーマクロまたはLLDマクロ可)のPrometheus出力。
9 2番目のパラメータにfunctionを選択した場合、集計関数のいずれか: sum, min, max, avg, count。
10 複数の"フィールド名,OIDプレフィックス,フォーマット"レコードを改行で区切って指定可能。