De volgende objecten zijn direct gerelateerd aan de item
API.
Webitems kunnen niet rechtstreeks worden gemaakt, bijgewerkt of verwijderd via de Zabbix API.
Het itemobject heeft de volgende eigenschappen.
Eigenschap | Type | Omschrijving |
---|---|---|
itemid | string | (alleen lezen) ID van het item. |
delay (vereist) |
string | Update-interval van het item. Accepteert seconden of een tijdseenheid met achtervoegsel (30s,1m,2u,1d). Optioneel kunnen één of meer aangepaste intervallen worden gespecificeerd, zowel als flexibele intervallen als planningsintervallen. Meerdere intervallen worden gescheiden door een puntkomma. Gebruikersmacro's kunnen worden gebruikt. Een enkele macro moet het hele veld vullen. Meerdere macro's in één veld of macro's gemengd met tekst worden niet ondersteund. Flexibele intervallen kunnen worden geschreven als twee macro's gescheiden door een schuine streep (bijv. {$FLEX_INTERVAL}/{$FLEX_PERIOD} ).Optioneel voor Zabbix trapper, afhankelijke items en voor Zabbix agent (actief) met de sleutel mqtt.get . |
hostid (vereist) |
string | ID van de host of het sjabloon waartoe het item behoort. Voor updatebewerkingen is dit veld alleen lezen. |
interfaceid (vereist) |
string | ID van de hostinterface van het item. Alleen gebruikt voor hostitems. Niet vereist voor Zabbix-agent (actief), Zabbix intern, Zabbix trapper, berekende, afhankelijke, database monitor en scriptitems. Optioneel voor HTTP-agentitems. |
key_ (vereist) |
string | Item-sleutel. |
name (vereist) |
string | Naam van het item. |
type (vereist) |
integer | Type van het item. Mogelijke waarden: 0 - Zabbix-agent; 2 - Zabbix-trapper; 3 - Eenvoudige controle; 5 - Zabbix intern; 7 - Zabbix-agent (actief); 9 - Webitem; 10 - Externe controle; 11 - Database monitor; 12 - IPMI-agent; 13 - SSH-agent; 14 - Telnet-agent; 15 - Berekend; 16 - JMX-agent; 17 - SNMP-trap; 18 - Afhankelijk item; 19 - HTTP-agent; 20 - SNMP-agent; 21 - Script |
url (vereist) |
string | URL-reeks, alleen vereist voor het itemtype HTTP-agent. Ondersteunt gebruikersmacro's, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}. |
value_type (vereist) |
integer | Type van de informatie van het item. Mogelijke waarden: 0 - numeriek met decimalen; 1 - karakter; 2 - logboek; 3 - numeriek zonder teken; 4 - tekst. |
allow_traps | integer | Veld voor HTTP-agentitem. Staat toe om de waarde ook op dezelfde manier als bij het type trapperitem in te vullen. 0 - (standaard) Sta niet toe om inkomende gegevens te accepteren. 1 - Sta toe om inkomende gegevens te accepteren. |
authtype | integer | Alleen gebruikt door SSH-agentitems of HTTP-agentitems. Mogelijke waarden voor SSH-agentauthenticatiemethode: 0 - (standaard) wachtwoord; 1 - openbare sleutel. Mogelijke waarden voor HTTP-agentauthenticatiemethode: 0 - (standaard) geen 1 - basis 2 - NTLM 3 - Kerberos |
description | string | Beschrijving van het item. |
error | string | (alleen lezen) Fouttekst als er problemen zijn bij het bijwerken van het item. |
flags | integer | (alleen lezen) Herkomst van het item. Mogelijke waarden: 0 - een gewoon item; 4 - een ontdekt item. |
follow_redirects | integer | Veld voor HTTP-agentitem. Volg de omleidingen in de respons bij het ophalen van gegevens. 0 - Volg geen omleidingen. 1 - (standaard) Volg omleidingen. |
headers | object | Veld voor HTTP(S)-verzoekskoppen in een HTTP-agentitem, waarbij de kopnaam als sleutel wordt gebruikt en de kopwaarde als waarde wordt gebruikt. Voorbeeld: { "User-Agent": "Zabbix" } |
history | string | Een tijdeenheid voor hoe lang de historische gegevens moeten worden bewaard. Accepteert ook gebruikersmacro's. Standaard: 90d. |
http_proxy | string | Veld voor HTTP(S)-proxyverbinding in een HTTP-agentitem. |
inventory_link | integer | ID van het hostinventarisveld dat wordt ingevuld door het item. Zie de hostinventarispagina voor een lijst met ondersteunde hostinventarisvelden en hun ID's. Standaard: 0. |
ipmi_sensor | string | IPMI-sensor. Alleen gebruikt door IPMI-items. |
jmx_endpoint | string | Aangepaste verbindingsreeks voor JMX-agent. Standaardwaarde: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi |
lastclock | timestamp | (alleen lezen) Tijd waarop het item voor het laatst is bijgewerkt. Standaard worden alleen waarden weergegeven die binnen de afgelopen 24 uur vallen. U kunt deze tijdsperiode verlengen door de waarde van de parameter Maximale weergaveperiode geschiedenis te wijzigen in het menu Beheer → Algemeen. |
lastns | integer | (alleen lezen) Nanoseconden waarop het item voor het laatst is bijgewerkt. Standaard worden alleen waarden weergegeven die binnen de afgelopen 24 uur vallen. U kunt deze tijdsperiode verlengen door de waarde van de parameter Maximale weergaveperiode geschiedenis te wijzigen in het menu Beheer → Algemeen. |
lastvalue | string | (alleen lezen) Laatste waarde van het item. Standaard worden alleen waarden weergegeven die binnen de afgelopen 24 uur vallen. U kunt deze tijdsperiode verlengen door de waarde van de parameter Maximale weergaveperiode geschiedenis te wijzigen in het menu Beheer → Algemeen. |
logtimefmt | string | Indeling van de tijd in logboekvermeldingen. Alleen gebruikt door logboekitems. |
master_itemid | integer | ID van het hoofditem. Recursie tot 3 afhankelijke items en een maximum aantal afhankelijke items van 29999 zijn toegestaan. Vereist voor afhankelijke items. |
output_format | integer | Veld voor HTTP-agentitem. Moet het antwoord worden geconverteerd naar JSON. 0 - (standaard) Bewaar rauw. 1 - Converteer naar JSON. |
params | string | Aanvullende parameters afhankelijk van het type item: - uitgevoerd script voor SSH- en Telnet-items; - SQL-query voor database monitor items; - formule voor berekende items; - het script voor scriptitem. |
parameters | array | Aanvullende parameters voor scriptitems. Array van objecten met de eigenschappen 'name' en 'value', waarbij de naam uniek moet zijn. |
password | string | Wachtwoord voor authenticatie. Gebruikt door eenvoudige controle, SSH, Telnet, database monitor, JMX en HTTP-agentitems. Wanneer gebruikt door JMX, moet ook de gebruikersnaam samen met het wachtwoord worden opgegeven of moeten beide eigenschappen leeg worden gelaten. |
post_type | integer | Veld voor HTTP-agentitem. Type post-gegevens die zijn opgeslagen in de eigenschap 'posts'. 0 - (standaard) Ruwe gegevens. 2 - JSON-gegevens. 3 - XML-gegevens. |
posts | string | Veld voor HTTP(S)-verzoek-gegevens in een HTTP-agentitem. Gebruikt met post_type. |
prevvalue | string | (alleen lezen) Vorige waarde van het item. Standaard worden alleen waarden weergegeven die binnen de afgelopen 24 uur vallen. U kunt deze tijdsperiode verlengen door de waarde van de parameter Maximale weergaveperiode geschiedenis te wijzigen in het menu Beheer → Algemeen. |
privatekey | string | Naam van het bestand met de privésleutel. |
publickey | string | Naam van het bestand met de openbare sleutel. |
query_fields | array | Veld voor HTTP-agentitem. Queryparameters. Array van objecten met paren 'key':'value', waarbij de waarde een lege tekenreeks kan zijn. |
request_method | integer | Veld voor HTTP-agentitem. Type verzoekmethode. 0 - (standaard) GET 1 - POST 2 - PUT 3 - HEAD |
retrieve_mode | integer | Veld voor HTTP-agentitem. Welk deel van het antwoord moet worden opgeslagen. 0 - (standaard) Lichaam. 1 - Koppen. 2 - Zowel lichaam als koppen worden opgeslagen. Voor aanvraagmethode HEAD is alleen de waarde 1 toegestaan. |
snmp_oid | string | SNMP OID. |
ssl_cert_file | string | Veld voor HTTP-agentitem. Pad naar het openbare SSL-sleutelbestand. |
ssl_key_file | string | Veld voor HTTP-agentitem. Pad naar het privé SSL-sleutelbestand. |
ssl_key_password | string | Veld voor HTTP-agentitem. Wachtwoord voor het SSL-sleutelbestand. |
state | integer | (alleen lezen) Status van het item. Mogelijke waarden: 0 - (standaard) normaal; 1 - niet ondersteund. |
status | integer | Status van het item. Mogelijke waarden: 0 - (standaard) ingeschakeld item; 1 - uitgeschakeld item. |
status_codes | string | Veld voor HTTP-agentitem. Reeksen vereiste HTTP-statuscodes gescheiden door komma's. Ondersteunt ook gebruikersmacro's als onderdeel van de met komma's gescheiden lijst. Voorbeeld: 200,200-{$M},{$M},200-400 |
templateid | string | (alleen lezen) ID van het bovenliggende sjabloonitem. Tip: Gebruik de eigenschap hostid om het sjabloon aan te geven waartoe het item behoort. |
timeout | string | Time-out voor het aanvragen van itemgegevens. Gebruikt voor HTTP-agent- en scriptitems. Ondersteunt gebruikersmacro's. standaard: 3s maximale waarde: 60s |
trapper_hosts | string | Toegestane hosts. Gebruikt door trapperitems of HTTP-agentitems. |
trends | string | Een tijdeenheid voor hoe lang de trendgegevens moeten worden bewaard. Accepteert ook gebruikersmacro's. Standaard: 365d. |
units | string | Eenheid van de waarde. |
username | string | Gebruikersnaam voor authenticatie. Gebruikt door eenvoudige controle, SSH, Telnet, database monitor, JMX en HTTP-agentitems. Vereist voor SSH- en Telnet-items. Wanneer gebruikt door JMX, moet ook het wachtwoord worden opgegeven samen met de gebruikersnaam of moeten beide eigenschappen leeg worden gelaten. |
uuid | string | Universeel uniek identificatienummer, gebruikt voor het koppelen van geïmporteerde items aan reeds bestaande items. Alleen gebruikt voor items op sjablonen. Wordt automatisch gegenereerd als het niet wordt opgegeven. |
valuemapid | string | ID van de bijbehorende waardeomzetting. |
verify_host | integer | Veld voor HTTP-agentitem. Valideer of de hostnaam in de URL zich bevindt in het veld Algemene naam of een veld Alternatieve naam van het hostcertificaat. 0 - (standaard) Niet valideren. 1 - Valideren. |
verify_peer | integer | Veld voor HTTP-agentitem. Valideer of het hostcertificaat authentiek is. 0 - (standaard) Niet valideren. 1 - Valideren. |
Merk op dat voor sommige methoden (update, delete) de vereiste/optie combinatie anders is.
Het item tag-object heeft de volgende eigenschappen.
Eigenschap | Type | Beschrijving |
---|---|---|
tag (verplicht) |
string | Naam itemtag. |
value | string | Waarde itemtag. |
Het object voorbewerking van het artikel heeft de volgende eigenschappen.
Property | Type | Beschrijving |
---|---|---|
type (vereist) |
geheel getal | Het type voorbewerkingsoptie. Mogelijke waarden: 1 - Aangepaste vermenigvuldiger; 2 - Rechts bijsnijden; 3 - Links bijsnijden; 4 - Bijsnijden; 5 - Overeenkomen met reguliere expressies; 6 - Booleaans naar decimaal; 7 - Octaal naar decimaal; 8 - Hexadecimaal naar decimaal; 9 - Eenvoudige wijziging; 10 - Wijziging per seconde; 11 - XML XPath; 12 - JSONPath; 13 - Binnen bereik; 14 - Komt overeen met reguliere expressie; 15 - Komt niet overeen met reguliere expressie; 16 - Controleer op fouten in JSON; 17 - Controleer op fouten in XML; 18 - Controleer op fouten met behulp van reguliere expressie; 19 - Verwijder ongewijzigd;<br >20 - Ongewijzigd weggooien met hartslag; 21 - JavaScript; 22 - Prometheus-patroon; 23 - Prometheus naar JSON; 24 - CSV naar JSON; 25 - Vervang;<br >26 - Controleer niet-ondersteund; 27 - XML naar JSON. |
params (verplicht) |
string | Aanvullende parameters gebruikt door voorbewerkingsoptie. Meerdere parameters worden gescheiden door een LF-teken (\n). |
error_handler (vereist) |
integer | Actietype gebruikt in geval van mislukte voorverwerkingsstap. Mogelijke waarden: 0 - Foutbericht is ingesteld door Zabbix-server;< br>1 - Waarde negeren; 2 - Aangepaste waarde instellen; 3 - Aangepaste foutmelding instellen. |
error_handler_params (vereist) |
string | Fouthandlerparameters. Gebruikt met error_handler .Moet leeg zijn als error_handler 0 of 1 is.Kan leeg zijn als error_handler 2 is.Kan niet leeg zijn als error_handler is 3. |
De volgende parameters en foutafhandelaars worden voor elk ondersteund: soort voorbewerking.
|Preprocessing type|Naam|Parameter 1|Parameter 2|Parameter 3|Ondersteunde fout-handlers| |------------------|----|-----------|-----------|- ----------|------------------------| |1|Aangepaste vermenigvuldiger|getal1, 6|<|<|0, 1, 2, 3| |2|Rechts bijsnijden|lijst met tekens2|<|<|<| |3|Links trim|lijst met tekens2|<|<|<| |4|Trim|lijst met tekens2|<|<|<| |5|Reguliere uitdrukking|patroon3|output2|<|0, 1, 2, 3| |6|Boolean naar decimaal|<|<|<|0, 1, 2, 3| |7|Octaal naar decimaal|<|<|<|0, 1, 2, 3| |8|Hexadecimaal naar decimaal|<|<|<|0, 1, 2, 3| |9|Eenvoudige wijziging|<|<|<|0, 1, 2, 3| |10|Verandering per seconde|<|<|<|0, 1, 2, 3| |11|XML XPath|pad4|<|<|0, 1, 2, 3| |12|JSONPath|pad4|<|<|0, 1, 2, 3| |13|Binnen bereik|min1, 6|max1, 6|<|0, 1, 2, 3| |14|Komt overeen met reguliere expressie|patroon3|<|<|0, 1, 2, 3| |15|Komt niet overeen met reguliere expressie|patroon3|<|<|0, 1, 2, 3| |16|Controleer op fouten in JSON|path4|<|<|0, 1, 2, 3| |17|Controleer op fouten in XML|pad4|<|<|0, 1, 2, 3| |18|Controleer op fouten met reguliere expressie|patroon3|output2|<|0, 1, 2, 3| |19|Gooi ongewijzigd weg|<|<|<|<| |20|Gooi ongewijzigd weg met hartslag|seconden5, 6|<|<|<| |21|JavaScript|script2|<|<|<| |22|Prometheus-patroon|patroon6, 7|value
, label
, function
|output8, 9|0, 1, 2, 3| |23|Prometheus naar JSON|patroon6, 7|<|<|0, 1, 2, 3| |24|CSV naar JSON|karakter2|karakter2|0,1|0, 1, 2, 3| |25|Vervangen|zoekreeks2|vervanging2|<|<| |26|Aanvinken niet ondersteund|<|<|<|1, 2, 3| |27|XML naar JSON|<|<|<|0, 1, 2, 3|
1 geheel getal of getal met drijvende komma
2 tekenreeks
3 reguliere expressie
4 JSONPath of XML XPath
5 positief geheel getal (met ondersteuning van tijdsuffixen, bijv. 30s, 1m, 2h, 1d)
6 gebruikersmacro
7 Prometheus-patroon volgens de syntaxis: <metrische naam>{<labelnaam>="<labelwaarde>", ...} == <waarde>
. Elk Prometheus-patrooncomponent (metrisch, labelnaam, labelwaarde en metriek waarde) kan een gebruikersmacro zijn.
8 Prometheus-uitvoer volgens de syntaxis: <labelnaam>
(kan een gebruikersmacro zijn) als label
is geselecteerd als de tweede parameter.
9 Een van de aggregatiefuncties: sum
, min
, max
, avg
, count
als function
is geselecteerd als de tweede parameter.