タスクオブジェクト

以下のオブジェクトは task API に直接関連しています。

タスク

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

プロパティ 型 説明
taskid ID タスクのID。

プロパティの動作:
- 読み取り専用
type integer タスクのタイプ。

指定可能な値:
1 - 診断情報;
2 - プロキシ設定の更新;
6 - 今すぐ実行。

Admin および User タイプのユーザーは、「今すぐ実行」タスクのみ作成できます。

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 permission を持つホスト上のアイテム、または read permission を持ち、かつそのロールで invoke_execute_now action が有効になっている場合に、「今すぐ実行」を実行できます。ローレベルディスカバリ（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 フィールドで取得されます。

プロパティ Type 説明
status integer タスク結果のステータス。

指定可能な値:
-1 - タスクの実行中にエラーが発生した。
0 - タスク結果が作成された。

プロパティの動作:
- 読み取り専用
data string/object 特定の診断情報タスクの統計リクエストオブジェクトに応じた結果。
タスクの実行中にエラーが発生した場合は、エラーメッセージ文字列が含まれます。