task.get

Beschrijving

integer/array task.get(object parameters)

Deze methode maakt het mogelijk om taken op te halen volgens de opgegeven parameters. De methode retourneert alleen details over taken met 'diagnostische informatie'.

Deze methode is alleen beschikbaar voor gebruikers van het type Superadmin. Toestemming om de methode te gebruiken kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruikersrollen voor meer informatie.

Parameters

(object) Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

Parameter	Type	Beschrijving
taskids	string/array	Retourneer alleen taken met de opgegeven ID's.
output	query	Deze parameters gelden voor alle `get`-methoden en worden in detail beschreven in de referentiecommentaar.
preservekeys	boolean

Retourwaarden

(integer/array) Retourneert een array van objecten.

Voorbeelden

Taak ophalen op basis van ID

Haal alle gegevens op over de taak met ID "1".

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "task.get",
           "params": {
               "output": "extend",
               "taskids": "1"
           },
           "id": 1
       }

Reactie:

{
           "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
       }

Zie ook

Bron

CTask::get() in ui/include/classes/api/services/CTask.php.

Documentation