datenpunktprototyp.get

Beschreibung

integer/array itemprototype.get(object parameters)

Mit dieser Methode können Datenpunkt-Prototypen entsprechend den angegebenen Parametern abgerufen werden.

Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(object) Parameter, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

Parameter Type Beschreibung
discoveryids ID/array Gibt nur Datenpunkt-Prototypen zurück, die zu den angegebenen LLD-Regeln gehören.
graphids ID/array Gibt nur Datenpunkt-Prototypen zurück, die in den angegebenen Graph-Prototypen verwendet werden.
hostids ID/array Gibt nur Datenpunkt-Prototypen zurück, die zu den angegebenen Hosts gehören.
inherited boolean Wenn auf true gesetzt, werden nur Datenpunkt-Prototypen zurückgegeben, die von einer Vorlage geerbt wurden.
itemids ID/array Gibt nur Datenpunkt-Prototypen mit den angegebenen IDs zurück.
monitored boolean Wenn auf true gesetzt, werden nur aktivierte Datenpunkt-Prototypen zurückgegeben, die zu überwachten Hosts gehören.
templated boolean Wenn auf true gesetzt, werden nur Datenpunkt-Prototypen zurückgegeben, die zu Vorlagen gehören.
templateids ID/array Gibt nur Datenpunkt-Prototypen zurück, die zu den angegebenen Vorlagen gehören.
triggerids ID/array Gibt nur Datenpunkt-Prototypen zurück, die in den angegebenen Auslöser-Prototypen verwendet werden.
selectDiscoveryData query Gibt eine discoveryData-Eigenschaft mit den Objektdaten der Datenpunkt-Prototyp-Erkennung zurück. Das Erkennungsobjekt des Datenpunkt-Prototyps verknüpft einen erkannten Datenpunkt-Prototyp mit einem Datenpunkt-Prototyp, aus dem er erkannt wurde.

Es hat die folgenden Eigenschaften:
parent_itemid - (string) ID des Datenpunkt-Prototyps, aus dem der Datenpunkt-Prototyp erstellt wurde;
key_ - (string) Schlüssel des Datenpunkt-Prototyps;
status - (int) Erkennungsstatus des Datenpunkt-Prototyps:
0 - (Standard) Datenpunkt-Prototyp wurde erkannt,
1 - Datenpunkt-Prototyp wird nicht mehr erkannt;
ts_delete - (timestamp) Zeitpunkt, zu dem ein Datenpunkt-Prototyp, der nicht mehr erkannt wird, gelöscht wird;
ts_disable - (timestamp) Zeitpunkt, zu dem ein Datenpunkt-Prototyp, der nicht mehr erkannt wird, deaktiviert wird;
disable_source - (int) Kennzeichen dafür, ob der Datenpunkt-Prototyp durch eine LLD-Regel oder manuell deaktiviert wurde:
0 - (Standard) automatisch deaktiviert,
1 - durch eine LLD-Regel deaktiviert.
selectDiscoveryRule query Gibt eine discoveryRule-Eigenschaft mit der Low-Level-Discovery-Regel zurück, zu der der Datenpunkt-Prototyp gehört.
selectDiscoveryRulePrototype query Gibt eine discoveryRulePrototype-Eigenschaft mit dem übergeordneten LLD-Regelprototyp zurück, zu dem der Datenpunkt-Prototyp gehört.
selectGraphs query Gibt eine graphs-Eigenschaft mit Graph-Prototypen zurück, in denen der Datenpunkt-Prototyp verwendet wird.

Unterstützt count.
selectHosts query Gibt eine hosts-Eigenschaft mit einem Array von Hosts zurück, zu denen der Datenpunkt-Prototyp gehört.
selectInheritedTags query Gibt eine inheritedTags-Eigenschaft mit Tags zurück, die auf Vorlage/Host/verknüpften Vorlagen vorhanden sind.
selectTags query Gibt die Tags des Datenpunkt-Prototyps in der Eigenschaft tags zurück.
selectTriggers query Gibt eine triggers-Eigenschaft mit Auslöser-Prototypen zurück, in denen der Datenpunkt-Prototyp verwendet wird.

Unterstützt count.
selectPreprocessing query Gibt eine preprocessing-Eigenschaft mit Vorverarbeitungsoptionen des Datenpunkt-Prototyps zurück.
selectValueMap query Gibt eine valuemap-Eigenschaft mit der Wertezuordnung des Datenpunkt-Prototyps zurück.
filter object Gibt nur die Ergebnisse zurück, die exakt dem angegebenen Filter entsprechen.

Akzeptiert ein Objekt, bei dem die Schlüssel Eigenschaftsnamen sind und die Werte entweder ein einzelner Wert oder ein Array von Werten sind, mit denen abgeglichen werden soll.

Unterstützt keine Eigenschaften vom text-data type.

Unterstützt zusätzliche Eigenschaften:
host - technischer Name des Hosts, zu dem der Datenpunkt-Prototyp gehört.
limitSelects integer Begrenzt die Anzahl der von Unterabfragen zurückgegebenen Datensätze.

Gilt für die folgenden Unterabfragen:
selectGraphs - Ergebnisse werden nach name sortiert;
selectTriggers - Ergebnisse werden nach description sortiert.
sortfield string/array Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: itemid, name, key_, delay, type, status, history, trends, discovered.
countOutput boolean Diese Parameter werden in der Referenzkommentierung beschrieben.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Rückgabewerte

(integer/array) Kann die folgenden Dinge zurück geben:

  • ein Array von Objekten;
  • die Anzahl der abgerufenen Objekte, wenn der Parameter countOutput verwendet wurde.

Beispiele

Abrufen von Datenpunkt-Prototypen aus einer LLD-Regel

Rufen Sie alle Datenpunkt-Prototypen für eine bestimmte LLD-Regel-ID ab.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "itemprototype.get",
    "params": {
        "output": "extend",
        "discoveryids": "27426"
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "23077",
            "type": "0",
            "snmp_oid": "",
            "hostid": "10079",
            "name": "Incoming network traffic on en0",
            "key_": "net.if.in[en0]",
            "delay": "1m",
            "history": "1w",
            "trends": "365d",
            "status": "0",
            "value_type": "3",
            "trapper_hosts": "",
            "units": "bps",
            "formula": "",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "2",
            "interfaceid": "0",
            "description": "",
            "inventory_link": "0",
            "lifetime": "7d",
            "evaltype": "0",
            "jmx_endpoint": "",
            "master_itemid": "0",
            "timeout": "",
            "url": "",
            "query_fields": [],
            "posts": "",
            "status_codes": "200",
            "follow_redirects": "1",
            "post_type": "0",
            "http_proxy": "",
            "headers": [],
            "retrieve_mode": "0",
            "request_method": "0",
            "output_format": "0",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "allow_traps": "0",
            "discover": "0",
            "uuid": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "parameters": []
        },
        {
            "itemid": "10010",
            "type": "0",
            "snmp_oid": "",
            "hostid": "10001",
            "name": "Processor load (1 min average per core)",
            "key_": "system.cpu.load[percpu,avg1]",
            "delay": "1m",
            "history": "1w",
            "trends": "365d",
            "status": "0",
            "value_type": "0",
            "trapper_hosts": "",
            "units": "",
            "formula": "",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "2",
            "interfaceid": "0",
            "description": "The processor load is calculated as system CPU load divided by number of CPU cores.",
            "inventory_link": "0",
            "lifetime": "7d",
            "evaltype": "0",
            "jmx_endpoint": "",
            "master_itemid": "0",
            "timeout": "",
            "url": "",
            "query_fields": [],
            "posts": "",
            "status_codes": "200",
            "follow_redirects": "1",
            "post_type": "0",
            "http_proxy": "",
            "headers": [],
            "retrieve_mode": "0",
            "request_method": "0",
            "output_format": "0",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "allow_traps": "0",
            "discover": "0",
            "uuid": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "parameters": []
        }
    ],
    "id": 1
}

Abhängigen Datenpunkt finden

Einen abhängigen Datenpunkt für eine bestimmte Datenpunkt-ID finden.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "itemprototype.get",
    "params": {
        "output": "extend",
        "filter": {
            "type": 18,
            "master_itemid": "25545"
        },
        "limit": "1"
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "25547",
            "type": "18",
            "snmp_oid": "",
            "hostid": "10116",
            "name": "Seconds",
            "key_": "apache.status.uptime.seconds",
            "delay": "0",
            "history": "90d",
            "trends": "365d",
            "status": "0",
            "value_type": "3",
            "trapper_hosts": "",
            "units": "",
            "formula": "",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "0",
            "interfaceid": "0",
            "description": "",
            "inventory_link": "0",
            "lifetime": "7d",
            "evaltype": "0",
            "jmx_endpoint": "",
            "master_itemid": "25545",
            "timeout": "",
            "url": "",
            "query_fields": [],
            "posts": "",
            "status_codes": "200",
            "follow_redirects": "1",
            "post_type": "0",
            "http_proxy": "",
            "headers": [],
            "retrieve_mode": "0",
            "request_method": "0",
            "output_format": "0",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "allow_traps": "0",
            "discover": "0",
            "uuid": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "parameters": []
        }
    ],
    "id": 1
}

HTTP-Agent-Datenpunktprototyp finden

HTTP-Agent-Datenpunktprototyp mit der Anfragemethode HEAD für eine bestimmte Host-ID finden.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "itemprototype.get",
    "params": {
        "hostids": "10254",
        "filter": {
            "type": 19,
            "request_method": 3
        }
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "28257",
            "type": "19",
            "snmp_oid": "",
            "hostid": "10254",
            "name": "discovered",
            "key_": "item[{#INAME}]",
            "delay": "{#IUPDATE}",
            "history": "90d",
            "trends": "30d",
            "status": "0",
            "value_type": "3",
            "trapper_hosts": "",
            "units": "",
            "formula": "",
            "logtimefmt": "",
            "templateid": "28255",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "2",
            "interfaceid": "2",
            "description": "",
            "inventory_link": "0",
            "lifetime": "7d",
            "evaltype": "0",
            "jmx_endpoint": "",
            "master_itemid": "0",
            "timeout": "",
            "url": "{#IURL}",
            "query_fields": [],
            "posts": "",
            "status_codes": "",
            "follow_redirects": "0",
            "post_type": "0",
            "http_proxy": "",
            "headers": [],
            "retrieve_mode": "0",
            "request_method": "3",
            "output_format": "0",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "allow_traps": "0",
            "discover": "0",
            "uuid": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "parameters": []
        }
    ],
    "id": 1
}

Siehe auch

Quelle

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