Table of Contents
タスクオブジェクト
以下のオブジェクトは task API に直接関連しています。
タスク
タスクオブジェクトには以下のプロパティがあります:
| プロパティ | タイプ | 説明 |
|---|---|---|
| taskid | ID | タスクのID。 プロパティの動作: - 読み取り専用 |
| type | integer | タスクのタイプ。 可能な値: 1 - 診断情報; 2 - プロキシ設定の更新; 6 - 今すぐ実行。 管理者およびユーザータイプのユーザーは「今すぐ実行」タスクのみ作成できます。 task.getは常に「7」（タスク実行サマリー）を返すことに注意してください。プロパティの動作: - 必須 |
| status | integer | タスクのステータス。 可能な値: 1 - 新しいタスク; 2 - タスク進行中; 3 - タスク完了; 4 - タスク期限切れ。 プロパティの動作: - 読み取り専用 |
| clock | timestamp | タスクが作成された時刻。 プロパティの動作: - 読み取り専用 |
| ttl | integer | タスクが期限切れになるまでの秒数。 プロパティの動作: - 読み取り専用 |
| proxyid | ID | 診断情報統計が収集されるプロキシのID。 プロパティの動作: - typeが「診断情報」または「プロキシ設定の更新」に設定されている場合にサポート |
| request | object | タスクタイプに応じたタスクリクエストオブジェクト: 「今すぐ実行」タスクのオブジェクトは以下で詳細に説明; 「プロキシ設定の更新」タスクのオブジェクトは以下で詳細に説明; 「診断情報」タスクのオブジェクトは以下で詳細に説明。 プロパティの動作: - 必須 |
| result | object | 診断情報タスクの結果オブジェクト。 結果がまだ準備できていない場合はNULLを含むことがあります。 結果オブジェクトは以下で詳細に説明。 プロパティの動作: - 読み取り専用 |
'今すぐ実行'リクエストオブジェクト
'今すぐ実行'タスクリクエストオブジェクトには、以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| itemid | ID | アイテムおよびローレベルディスカバリールールのID。 AdminおよびUserタイプのユーザーは、read-writeの権限を持つホスト、またはread権限とロールに対して invoke_execute_now アクションが有効になっている場合に、アイテムを'今すぐ実行'できます。ローレベルディスカバリー（LLD）ルールについてもAdminタイプのユーザーに同様に適用されます。 |
'プロキシ設定の更新'リクエストオブジェクト
'プロキシ設定の更新'タスクリクエストオブジェクトには、以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| proxyids | 配列 | プロキシID |
'Diagnostic information' リクエストオブジェクト
診断情報タスクリクエストオブジェクトには、以下のプロパティがあります。すべてのタイプのプロパティの統計リクエストオブジェクトについては、以下で詳細に説明しています。
| プロパティ | タイプ | 説明 |
|---|---|---|
| historycache | object | ヒストリキャッシュ統計リクエスト。サーバーおよびプロキシで利用可能。 |
| valuecache | object | アイテムキャッシュ統計リクエスト。サーバーで利用可能。 |
| preprocessing | object | 前処理マネージャ統計リクエスト。サーバーおよびプロキシで利用可能。 |
| alerting | object | アラートマネージャ統計リクエスト。サーバーで利用可能。 |
| lld | object | LLDマネージャ統計リクエスト。サーバーで利用可能。 |
統計リクエストオブジェクト
統計リクエストオブジェクトは、サーバー/プロキシの内部プロセスに関してどのタイプの情報を収集するかを定義するために使用されます。以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| 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 | キューイングされた値の数 |
各種診断情報リクエストで利用可能なソートフィールドのリスト
要求された情報をソートおよび制限するために、以下の統計フィールドを使用できます。
| 診断タイプ | 利用可能なフィールド | タイプ |
|---|---|---|
| historycache | values | integer |
| valuecache | values | integer |
| request.values | integer | |
| preprocessing | values | integer |
| alerting | media.alerts | integer |
| source.alerts | integer | |
| lld | values | integer |
統計結果オブジェクト
統計結果オブジェクトは、タスクオブジェクトのresultフィールドで取得されます。