Sidebar

Become a monitoring expert!
Sign up for Zabbix training

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 Retourneer alleen ontdekte services met de opgegeven ID's.
dhostids string/array Retourneer alleen ontdekte services die behoren tot de opgegeven ontdekte hosts.
dcheckids string/array Retourneer alleen ontdekte services die zijn gedetecteerd door de gegeven discovery-controles.
druleids string/array Retourneer alleen ontdekte services die zijn gedetecteerd door de gegeven ontdekkingsregels.
selectDRules query Retourneer een eigenschap drules met een array van de detectieregels die de service hebben gedetecteerd.
selectDHosts query Retourneer een eigenschap dhosts met een array van de ontdekte hosts waartoe de service behoort.
selectHosts query Retourneer een eigenschap hosts met de hosts met hetzelfde IP-adres en dezelfde proxy als de service.

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

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

Mogelijke waarden zijn: dserviceid, dhostid en ip.
countOutput boolean Deze parameters gelden voor alle get-methoden en worden in detail beschreven in de referentiecommentaar.
editable booleaans
excludeSearch boolean
filter object
limiet geheel getal
uitvoer query
preservekeys boolean
zoeken object
searchByAny boolean
searchWildcardsIngeschakeld boolean
sortorde string/array
startZoeken booleaans

Retourwaarden

(integer/array) Retourneert ofwel:

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

Voorbeelden

Ontdekkingscontroles ophalen voor een ontdekkingsregel

Haal alle detectiecontroles op die worden gebruikt door detectieregel "6".

Verzoek:

{
           "jsonrpc": "2.0",
           "method": "dcheck.get",
           "params": {
               "output": "extend",
               "dcheckids": "6"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Antwoord:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "dcheckid": "6",
                   "druleid": "4",
                   "type": "3",
                   "key_": "",
                   "snmp_community": "",
                   "ports": "21",
                   "snmpv3_securityname": "",
                   "snmpv3_securitylevel": "0",
                   "snmpv3_authpassphrase": "",
                   "snmpv3_privpassphrase": "",
                   "uniq": "0",
                   "snmpv3_authprotocol": "0",
                   "snmpv3_privprotocol": "0",
                   "host_source": "1",
                   "name_source": "0"            
               }
           ],
           "id": 1
       }

Zie ook

Bron

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