dservice.get

Beschrijving

integer/array dservice.get(objectparameters)

De methode maakt het mogelijk om ontdekte services op te halen volgens de gegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.

Parameters

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

De methode ondersteunt de volgende parameters.

Parameter Type Beschrijving
dserviceids string/array Geef alleen ontdekte services terug met de opgegeven IDs.
dhostids string/array Geef alleen ontdekte services terug die behoren tot de opgegeven ontdekte hosts.
dcheckids string/array Geef alleen ontdekte services terug die gedetecteerd zijn door de opgegeven ontdekkingscontroles.
druleids string/array Geef alleen ontdekte services terug die gedetecteerd zijn door de opgegeven ontdekkingsregels.
selectDRules query Geef een eigenschap drules terug met een reeks ontdekkingsregels die de service hebben gedetecteerd.
selectDHosts query Geef een eigenschap dhosts terug met een reeks ontdekte hosts waartoe de service behoort.
selectHosts query Geef een eigenschap hosts terug met de hosts met hetzelfde IP-adres en proxy als de service.

Ondersteunt count.
limitSelects integer Beperkt het aantal records dat wordt geretourneerd door subselecties.

Van toepassing op de volgende subselecties:
selectHosts - het resultaat wordt gesorteerd op hostid.
sortfield string/array Sorteer het resultaat op basis van de opgegeven eigenschappen.

Mogelijke waarden: dserviceid, dhostid, ip.
countOutput boolean Deze parameters, die gemeenschappelijk zijn voor alle get-methoden, worden in detail beschreven in het referentiecommentaar.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Retourwaarden

(integer/array) Retourneert ofwel:

  • een reeks objecten;
  • het aantal opgehaalde objecten, als de countOutput parameter heeft gebruikt.

Voorbeelden

Ontdekte services ophalen op een host

Haal alle ontdekte services op die gedetecteerd zijn op ontdekte host "11".

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "dservice.get",
           "params": {
               "output": "extend",
               "dhostids": "11"
           },
           "id": 1
       }

Reactie:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "dserviceid": "12",
                   "dhostid": "11",
                   "value": "",
                   "port": "80",
                   "status": "1",
                   "lastup": "0",
                   "lastdown": "1348650607",
                   "dcheckid": "5",
                   "ip": "192.168.1.134",
                   "dns": "john.local"
               },
               {
                   "dserviceid": "13",
                   "dhostid": "11",
                   "value": "",
                   "port": "21",
                   "status": "1",
                   "lastup": "0",
                   "lastdown": "1348650610",
                   "dcheckid": "6",
                   "ip": "192.168.1.134",
                   "dns": "john.local"
               }
           ],
           "id": 1
       }

Zie ook

Bron

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