task.get
説明
integer/array task.get(object parameters)
このメソッドは、指定されたパラメータに従ってタスクを取得することができます。
このメソッドはスーパ管理者ユーザータイプでのみ利用可能です。 このメソッドを呼び出す権限は、ユーザーロールの設定で取り消すことができます。詳細はユーザーロールを参照してください。
パラメータ
(object) 望ましい出力を定義するパラメータ。
このメソッドは以下のパラメータをサポートします。
| パラメータ | タイプ | 説明 |
|---|---|---|
| taskids | ID/array | 指定したIDのタスクのみを返します。 |
| output | query | これらのパラメータはリファレンス解説で説明されています。 |
| preservekeys | boolean |
戻り値
(integer/array) オブジェクトの配列を返します
例
IDでタスクを取得
IDが"1"のタスクに関するすべてのデータを取得します。
{
"jsonrpc": "2.0",
"method": "task.get",
"params": {
"output": "extend",
"taskids": "1"
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": [
{
"taskid": "1",
"type": "7",
"status": "3",
"clock": "1601039076",
"ttl": "3600",
"proxyid": 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.