Documentation
task.get
説明
integer/array task.get(object parameters)
このメソッドを使用すると、指定されたパラメーターに従ってタスクを取得できます。 メソッドは'診断情報'タスクに関する詳細のみを返します。
このメソッドはSuper adminユーザータイプでのみ使用できます。 メソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。 詳細についてはユーザーの役割を参照してください。
パラメータ
(object) 目的の出力を定義するパラメーター。
このメソッドは、次のパラメーターをサポートします。
| パラメータ | タイプ | 説明 |
|---|---|---|
| taskids | string/array | 指定されたIDを持つタスクのみを返します |
| output | query | すべてのgetメソッドに共通するこれらのパラメーターについてはリファレンス解説ページで詳しく説明されています |
| preservekeys | boolean |
戻り値
(integer/array) オブジェクトの配列を返します
例
IDでタスクを取得
ID"1"のタスクに関するすべてのデータを取得します
Request:
{ "jsonrpc": "2.0", "method": "task.get", "params": { "output": "extend", "taskids": "1" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Response:
{ "jsonrpc": "2.0", "result": [ { "taskid": "1", "type": "7", "status": "3", "clock": "1601039076", "ttl": "3600", "proxy_hostid": null, "request": { "alerting": { "stats": [ "alerts" ], "top": { "media.alerts": 10 } }, "lld": { "stats": "extend", "top": { "values": 5 } } }, "result": { "data": { "alerting": { "alerts": 0, "top": { "media.alerts": [] }, "time": 0.000663 }, "lld": { "rules": 0, "values": 0, "top": { "values": [] }, "time": 0.000442 } }, "status": "0" } } ], "id": 1 }参照
ソース
CTask::get() in ui/include/classes/api/services/CTask.php.