このページで
タスクオブジェクト
以下のオブジェクトは task API に直接関連しています。
タスク
タスクオブジェクトには、以下のプロパティがあります。
| Property | Type | Description |
|---|---|---|
| taskid | ID | タスクのID。 Property behavior: - read-only |
| type | integer | タスクのタイプ。 指定可能な値: 1 - 診断情報; 2 - プロキシ設定の更新; 6 - 今すぐ実行。 Zabbix 7.0.19以降、Admin および User タイプのユーザーは「今すぐ実行」タスクを作成できます。 なお、 task.get は常に "7"（タスク実行サマリー）を返します。Property behavior: - required |
| status | integer | タスクのステータス。 指定可能な値: 1 - 新規タスク; 2 - 進行中のタスク; 3 - 完了したタスク; 4 - 期限切れのタスク。 Property behavior: - read-only |
| clock | timestamp | タスクが作成された時刻。 Property behavior: - read-only |
| ttl | integer | タスクの有効期限が切れるまでの秒数。 Property behavior: - read-only |
| proxyid | ID | 診断情報の統計が収集される対象のプロキシのID。 Property behavior: - type が「診断情報」または「プロキシ設定の更新」に設定されている場合に supported |
| request | object | タスクタイプに応じたタスクリクエストオブジェクト: 「今すぐ実行」タスクのオブジェクトは以下で詳しく説明されています; 「プロキシ設定の更新」タスクのオブジェクトは以下で詳しく説明されています; 「診断情報」タスクのオブジェクトは以下で詳しく説明されています。 Property behavior: - required |
| result | object | 診断情報タスクの結果オブジェクト。 結果の準備がまだできていない場合は NULL を含むことがあります。 結果オブジェクトは以下で詳しく説明されています。 Property behavior: - read-only |
「今すぐ実行」リクエストオブジェクト
「今すぐ実行」タスクのリクエストオブジェクトには、以下のプロパティがあります。
| プロパティ | 型 | 説明 |
|---|---|---|
| itemid | ID | アイテムおよびローレベルディスカバリールールのID。 Zabbix 7.0.19以降、Admin および User タイプのユーザーは、read-write permission を持つホスト、または read permission を持ち、かつそのロールで invoke_execute_now action が有効になっているホスト上のアイテムに対して「今すぐ実行」を実行できます。ローレベルディスカバリー（LLD）ルールについても、Admin タイプのユーザーに同様に適用されます。 |
「プロキシ設定の更新」リクエストオブジェクト
「プロキシ設定の更新」タスクリクエストオブジェクトには、以下のプロパティがあります。
| プロパティ | Type | 説明 |
|---|---|---|
| proxyids | array | プロキシID。 |
「診断情報」リクエストオブジェクト
診断情報タスクのリクエストオブジェクトには、以下の プロパティがあります。すべての種類のプロパティに対する統計リクエストオブジェクトは、 以下で詳しく説明されています。
| プロパティ | Type | 説明 |
|---|---|---|
| historycache | object | 履歴キャッシュの統計リクエスト。サーバーおよびプロキシで使用できます。 |
| valuecache | object | アイテムキャッシュの統計リクエスト。サーバーで使用できます。 |
| preprocessing | object | 前処理マネージャーの統計リクエスト。サーバーおよびプロキシで使用できます。 |
| alerting | object | アラートマネージャーの統計リクエスト。サーバーで使用できます。 |
| lld | object | LLDマネージャーの統計リクエスト。サーバーで使用できます。 |
統計リクエストオブジェクト
統計リクエストオブジェクトは、サーバー/プロキシの内部プロセスについてどの種類の情報を収集するかを定義するために使用されます。
このオブジェクトには、以下のプロパティがあります。
| Property | Type | Description |
|---|---|---|
| stats | query | 返される統計オブジェクトのプロパティ。 診断情報の統計の種類ごとに利用可能なフィールドの一覧は、以下で詳しく説明されています。 デフォルト: extend は利用可能なすべての統計フィールドを返します。 |
| top | object | 返される統計値をソートおよび制限するためのオブジェクト。 診断情報の統計の種類ごとに利用可能なフィールドの一覧は、以下で詳しく説明されています。 例: { "source.alerts": 10 } |
診断情報リクエストの各タイプで利用可能な統計フィールドの一覧
診断情報リクエストプロパティの各タイプについて、以下の統計フィールドを要求できます。
| Diagnostic type | Available fields | Description |
|---|---|---|
| historycache | items | キャッシュされたアイテム数。 |
| values | キャッシュされた値の数。 | |
| memory | 共有メモリの統計情報（空き領域、使用中チャンク数、空きチャンク数、空きチャンクの最大サイズ）。 | |
| memory.data | 履歴データキャッシュの共有メモリ統計情報。 | |
| memory.index | 履歴インデックスキャッシュの共有メモリ統計情報。 | |
| valuecache | items | キャッシュされたアイテム数。 |
| values | キャッシュされた値の数。 | |
| memory | 共有メモリの統計情報（空き領域、使用中チャンク数、空きチャンク数、空きチャンクの最大サイズ）。 | |
| mode | 値キャッシュのモード。 | |
| preprocessing | values | キューに入っている値の数。 |
| preproc.values | 前処理ステップを持つキュー内の値の数。 | |
| alerting | alerts | キューに入っているアラート数。 |
| lld | rules | キューに入っているルール数。 |
| values | キューに入っている値の数。 |
診断情報リクエストの各タイプで利用可能なソートフィールドの一覧
以下の統計フィールドを使用して、要求された情報のソートおよび制限を行うことができます。
| 診断タイプ | 利用可能なフィールド | Type |
|---|---|---|
| historycache | values | integer |
| valuecache | values | integer |
| request.values | integer | |
| preprocessing | values | integer |
| alerting | media.alerts | integer |
| source.alerts | integer | |
| lld | values | integer |
統計結果オブジェクト
統計結果オブジェクトは、タスクオブジェクトの result フィールドで取得されます。