このページで
タスクオブジェクト
以下のオブジェクトは task API に直接関連しています。
タスク
タスクオブジェクトには、次のプロパティがあります。
| Property | Type | Description |
|---|---|---|
| taskid | ID | タスクのIDです。 Property behavior: - read-only |
| type | integer | タスクの種類です。 Possible values: 1 - Diagnostic information; 2 - Refresh proxy configuration; 6 - Execute now. Zabbix 7.4.3以降、Admin および User タイプのユーザーは 'Execute now' タスクを作成できます。 なお、 task.get は常に "7"（Task execution summary）を返します。Property behavior: - required |
| status | integer | タスクのステータスです。 Possible values: 1 - new task; 2 - task in progress; 3 - task is completed; 4 - task is expired. Property behavior: - read-only |
| clock | timestamp | タスクが作成された時刻です。 Property behavior: - read-only |
| ttl | integer | タスクが期限切れになるまでの秒数です。 Property behavior: - read-only |
| proxyid | ID | 診断情報の統計が収集されるプロキシのIDです。 Property behavior: - supported if type is set to "Diagnostic information" or "Refresh proxy configuration" |
| request | object | タスク種別に応じたタスクリクエストオブジェクトです。 'Execute now' タスクのオブジェクトは以下で詳しく説明します; 'Refresh proxy configuration' タスクのオブジェクトは以下で詳しく説明します; 'Diagnostic information' タスクのオブジェクトは以下で詳しく説明します. Property behavior: - required |
| result | object | 診断情報タスクの結果オブジェクトです。 結果がまだ準備できていない場合は NULL を含むことがあります。 結果オブジェクトは以下で詳しく説明します. Property behavior: - read-only |
'Execute now' リクエストオブジェクト
'Execute now' タスクのリクエストオブジェクトには、次のプロパティがあります。
| Property | Type | Description |
|---|---|---|
| itemid | ID | アイテムおよび low-level discovery ルールのID。 Zabbix 7.4.3以降、Admin および User タイプのユーザーは、read-write 権限を持つホスト、または read 権限とロールで invoke_execute_now アクション が有効になっているホスト上のアイテムに対して 'Execute now' を実行できます。low-level discovery (LLD) ルールについても、同様に Admin タイプのユーザーに適用されます。 |
「プロキシ設定のリフレッシュ」リクエストオブジェクト
「プロキシ設定のリフレッシュ」タスクリクエストオブジェクトには、以下のプロパティがあります。
| プロパティ | Type | 説明 |
|---|---|---|
| proxyids | array | プロキシID。 |
「Diagnostic information」リクエストオブジェクト
診断情報タスクリクエストオブジェクトには、以下のプロパティがあります。すべての種類のプロパティに対する統計リクエストオブジェクトについては、以下で詳しく説明しています。
| プロパティ | 型 | 説明 |
|---|---|---|
| historycache | object | 履歴キャッシュの統計リクエスト。サーバーおよびプロキシで使用できます。 |
| valuecache | object | アイテムキャッシュの統計リクエスト。サーバーで使用できます。 |
| preprocessing | object | 前処理マネージャーの統計リクエスト。サーバーおよびプロキシで使用できます。 |
| alerting | object | アラートマネージャーの統計リクエスト。サーバーで使用できます。 |
| lld | object | LLDマネージャーの統計リクエスト。サーバーで使用できます。 |
統計リクエストオブジェクト
統計リクエストオブジェクトは、サーバー/プロキシの内部プロセスについてどの種類の情報を収集するかを定義するために使用されます。以下のプロパティがあります。
| Property | Type | Description |
|---|---|---|
| stats | query | 返される統計オブジェクトのプロパティ。 診断情報統計の各タイプで利用可能なフィールドの一覧は、以下で詳しく説明されています。 デフォルト: extend は利用可能なすべての統計フィールドを返します。 |
| top | object | 返される統計値をソートおよび制限するためのオブジェクト。 診断情報統計の各タイプで利用可能なフィールドの一覧は、以下で詳しく説明されています。 例: { “source.alerts”: 10 } |
各種診断情報リクエストタイプで利用可能な統計フィールドの一覧
各種診断情報リクエストプロパティでリクエスト可能な統計フィールドは以下の通りです。
| 診断タイプ | 利用可能なフィールド | 説明 |
|---|---|---|
| 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 フィールドで取得されます。