Documentation
Table of Contents
Itemオブジェクト
次のオブジェクトは、itemAPIに直接関連しています。
item
Zabbix API を使用して Web アイテムを直接作成、更新、または削除することはできません。
item オブジェクトには次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| itemid | string | (読取専用) アイテムID |
| delay (必須) |
string | アイテムの更新間隔。 秒またはサフィックス付きの時間単位 (30s、1m、2h、1d) を受け入れます。 オプションで、1 つまたは複数の カスタム間隔 を柔軟な間隔またはスケジューリングとして指定できます。 複数の間隔はセミコロンで区切ります。 ユーザーマクロを使用できます。 1 つのマクロでフィールド全体を埋める必要があります。 フィールド内の複数のマクロまたはテキストと混合されたマクロはサポートされていません。 柔軟な間隔は、スラッシュで区切られた 2 つのマクロとして記述できます (例: {$FLEX_INTERVAL}/{$FLEX_PERIOD})。Zabbix トラッパー、依存アイテム、および mqtt.get キーを使用した Zabbix エージェント (アクティブ) のオプション。 |
| hostid (required) |
string | アイテムが属するホストまたはテンプレートの ID 更新操作の場合、このフィールドは 読取専用 です。 |
| interfaceid (必須) |
string | アイテムのホストインターフェースの ID ホスト アイテムにのみ使用されます。 Zabbix エージェント (アクティブ)、Zabbix インターナル、Zabbix トラッパー、計算、依存、データベース モニター、およびスクリプト アイテムには必要ありません。 HTTP エージェント アイテムのオプションです。 |
| key_ (required) |
string | アイテムキー |
| name (required) |
string | アイテム名 |
| type (required) |
integer | アイテムのタイプ 使用可能な値: 0 - Zabbix エージェント 2 - Zabbix トラッパー 3 - シンプル チェック 5 - Zabbix インターナル 7 - Zabbix エージェント (アクティブ) 9 - Web アイテム 10 - 外部チェック 11 - データベース監視 12 - IPMI エージェント 13 - SSH エージェント 14 - Telnet エージェント 15 - 計算済み 16 - JMX エージェント 17 - SNMP トラップ 18 - 依存アイテム 19 - HTTP エージェント 20 - SNMP エージェント 21 - スクリプト |
| url (required) |
string | URL 文字列。HTTP エージェント アイテム タイプにのみ必要です。 ユーザー マクロ{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{ITEM.ID}、{ITEM.KEY} をサポートします。 |
| value_type (必須) |
integer | アイテムの情報タイプ 使用可能な値: 0 - 浮動小数点数 1 - キャラクター 2 - ログ 3 - 符号なしの数値 4 - テキスト |
| allow_traps | integer | HTTP エージェントアイテムフィールド。 トラッパー アイテム タイプと同様に、値の入力を許可します。 0 - (デフォルト) 着信データの受け入れを許可しません。 1 - 着信データの受け入れを許可します。 |
| authtype | integer | SSH エージェント アイテムまたは HTTP エージェント アイテムでのみ使用されます。 SSH エージェント認証方法の使用可能な値: 0 - (デフォルト) パスワード 1 - 公開鍵 HTTP エージェント認証方式の使用可能な値: 0 - (デフォルト) なし 1 - Basic 2 - NTLM 3 - Kerberos |
| description | string | アイテムの説明 |
| error | string | (読取専用) アイテムの更新に問題がある場合のエラー テキスト |
| flags | integer | (読取専用) アイテムの起源 使用可能な値: 0 - プレーンなアイテム 4 - 発見されたアイテム |
| follow_redirects | integer | HTTP エージェントアイテムフィールド。 データのプール中に応答リダイレクトに従うか 0 - リダイレクトに従いません 1 - (デフォルト) リダイレクトに従います |
| headers | object | HTTP エージェントアイテムフィールド。 ヘッダー名がキーとして使用され、ヘッダー値が値として使用される HTTP(S) リクエスト ヘッダーを持つオブジェクト。 例: { "User-Agent": "Zabbix" } |
| history | string | 履歴データを保存する時間の単位。 ユーザー マクロも受け入れます。 デフォルト: 90d |
| http_proxy | string | HTTP エージェントアイテムフィールド。 HTTP(S) プロキシ接続文字列。 |
| inventory_link | integer | アイテムによって入力されるホストインベントリフィールドID サポートされているホストインベントリフィールドのリストについては、ホスト インベントリ ページ を参照してください。 デフォルト: 0。 |
| ipmi_sensor | string | IPMI センサー。 IPMI アイテムでのみ使用されます |
| jmx_endpoint | string | JMX エージェントのカスタム接続文字列。 デフォルト値: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi |
| lastclock | timestamp | (読取専用) アイテムが最後に更新された時刻。 デフォルトでは、過去 24 時間以内の値のみが表示されます。 管理 → 一般設定 メニュー セクションの データの保存期間パラメータ値を変更することで、この期間を延長できます。 |
| lastns | integer | (読取専用) アイテムが最後に更新されたときのナノ秒 デフォルトでは過去 24 時間以内の値のみが表示されます。 管理 → 一般設定 メニュー セクションの データの保存期間パラメータ値を変更することで、この期間を延長できます。 |
| lastvalue | string | (読取専用)アイテムの最後の値 デフォルトでは過去 24 時間以内の値のみが表示されます。 管理 → 一般設定 メニュー セクションの データの保存期間パラメータ値を変更することで、この期間を延長できます。 |
| logtimefmt | string | ログ エントリの時刻形式。 ログアイテムでのみ使用されます。 |
| master_itemid | integer | マスター アイテム ID 最大 3 つの従属アイテムの再帰と 最大29999 の従属アイテムが許可されます 従属アイテムに必要です |
| output_format | integer | HTTP エージェントアイテムフィールド。 レスポンスを JSON に変換する必要があります。 0 - (デフォルト) そのまま保存します 1 - JSON に変換します |
| params | string | アイテムのタイプに応じた追加パラメータ: - SSH および Telnet アイテムの実行スクリプト - データベース監視アイテムの SQL クエリ - 計算アイテムの式 - スクリプトのスクリプト アイテム |
| parameters | array | スクリプトアイテムの追加パラメーター。 'name' および 'value' プロパティを持つオブジェクトの配列。name は一意である必要があります |
| password | string | 認証用のパスワード。 簡易チェック、SSH、Telnet、データベース監視、JMX、HTTPエージェントのアイテムで使用 |
| post_type | integer | HTTP エージェントアイテムフィールド。 posts プロパティに格納される投稿データ本体のタイプ。 0 - (デフォルト) 生データ。 2 - JSON データ。 3 - XML データ。 |
| posts | string | HTTP エージェントアイテムフィールド。 HTTP(S) リクエストの本文データ。 post_type で使用します。 |
| prevvalue | string | (読取専用) アイテムの以前の値 デフォルトでは過去 24 時間以内の値のみが表示されます。 管理 → 一般設定 メニュー セクションの データの保存期間パラメータ値を変更することで、この期間を延長できます。 |
| privatekey | string | 秘密鍵ファイル名 |
| publickey | string | 公開鍵ファイル名 |
| query_fields | array | HTTP エージェントアイテムフィールド。 クエリ パラメータ。 'キー':'値'のペアを持つオブジェクトの配列。値は空の文字列にすることができます。 |
| request_method | integer | HTTP エージェントアイテムフィールド。 リクエスト メソッドのタイプ。 0 - (デフォルト) GET 1 - POST 2 - PUT 3 - HEAD |
| retrieve_mode | integer | HTTP エージェントアイテムフィールド。 レスポンスのどの部分を保存するか。 0 - (デフォルト) 本文 1 - ヘッダー 2 - 本文とヘッダーの両方 request_method HEAD の場合、許可される値は 1 のみ |
| snmp_oid | string | SNMP OID. |
| ssl_cert_file | string | HTTP エージェントアイテムフィールド。 公開 SSL キーファイル パス |
| ssl_key_file | string | HTTP エージェントアイテムフィールド。 プライベート SSL キーファイル パス |
| ssl_key_password | string | HTTP エージェントアイテムフィールド。 SSL キー ファイルのパスワード |
| state | integer | (読取専用) アイテムの状態 使用可能な値: 0 - (デフォルト) 通常 1 - サポートされていません |
| status | integer | アイテムのステータス 使用可能な値: 0 - (デフォルト) 有効なアイテム 1 - 無効なアイテム |
| status_codes | string | HTTP エージェントアイテムフィールド。 コンマで区切られた必須の HTTP ステータス コードの範囲。 コンマ区切りリストの一部としてユーザー マクロもサポートします。 例: 200,200-{$M},{$M},200-400 |
| templateid | string | (読取専用) 親テンプレート アイテムの ID。 ヒント: hostid プロパティを使用して、アイテムが属するテンプレートを指定します。 |
| timeout | string | アイテム データ ポーリング リクエストのタイムアウト。 HTTP エージェントおよびスクリプト アイテムに使用されます。 ユーザー マクロをサポートします。 デフォルト: 3 秒 最大値: 60 秒 |
| trapper_hosts | string | 許可されたホスト。 トラッパー アイテムまたは HTTP エージェント アイテムで使用されます。 |
| trends | string | トレンド データを保存する時間の単位。 ユーザー マクロも受け入れます。 デフォルト: 365d |
| units | string | 値の単位 |
| username | string | 認証用のユーザー名。 簡易チェック、SSH、Telnet、データベース監視、JMX、HTTPエージェントのアイテムで使用 SSH、Telnetのアイテムで必須 JMX で使用する場合、パスワードもユーザー名と一緒に指定するか、両方のプロパティを空白のままにする必要があります。 |
| uuid | string | インポートされたアイテムを既存のアイテムにリンクするために使用されるユニバーサル一意識別子。 テンプレートのアイテムにのみ使用されます。 指定されていない場合は自動生成されます。 更新操作の場合、このフィールドは 読取専用 です。 |
| valuemapid | string | 関連付けられた値マップID |
| verify_host | integer | HTTP エージェントアイテムフィールド。 URL のホスト名がホスト証明書の Common Name フィールドまたは Subject Alternate Name フィールドにあることを検証します。 0 - (デフォルト) 検証しません。 1 - 検証します。 |
| verify_peer | integer | HTTP エージェントアイテムフィールド。 検証はホスト証明書の認証です。 0 - (デフォルト) 検証しません。 1 - 検証します。 |
HTTP header
ヘッダーオブジェクトには以下のプロパティがあります。
HTTP query field
クエリフィールドオブジェクトは、URL パラメータを指定するために使用される名前と値を定義します。 以下のプロパティがあります。
Item tag
item tagオブジェクトには次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| tag (必須) |
string | アイテムタグ名 |
| value | string | アイテムタグ値 |
アイテムの前処理
アイテム前処理オブジェクトには、次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| 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 へ<br >24 - CSV から JSONへ 25 - 置換 26 - サポートされていないチェック 27 - XML から JSONへ |
| params (必須) |
string | 前処理オプションで使用される追加パラメーター。 複数のパラメータはLF (\n) 文字で区切られます。 |
| error_handler (必須) |
integer | 前処理ステップが失敗した場合に使用されるアクションタイプ 使用可能な値: 0 - エラー メッセージは Zabbix サーバーによって設定されます。 1 - 値を破棄します。 2 - カスタム値を設定します。 3 - カスタム エラー メッセージを設定します。 |
| error_handler_params (必須) |
string | エラー ハンドラーのパラメーター。 error_handler とともに使用されます。error_handler が 0 または 1 の場合、空にする必要があります。error_handler が 2 の場合、空にすることができます。error_handler が 3 の場合、空にすることはできません。 |
前処理の種類ごとに、次のパラメーターとエラー ハンドラーがサポートされています。
| 前処理の種類 | 名前 | パラメータ1 | パラメータ2 | パラメータ3 | サポートするエラーハンドラ |
|---|---|---|---|---|---|
| 1 | カスタム乗数 | number1, 6 | 0, 1, 2, 3 | ||
| 2 | 右トリム | list of characters2 | |||
| 3 | 左トリム | list of characters2 | |||
| 4 | トリム | list of characters2 | |||
| 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 | サポートされていないチェック | 1, 2, 3 | |||
| 27 | XML から JSONへ | 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 は次の構文で出力します: <label name> (ユーザー マクロを使用できます) label が 2 番目のパラメーターとして選択されている場合。
9 集計関数の 1 つ: sum,min,max,avg,count (function が 2 番目のパラメーターとして選択されている場合)