Documentation
Table of Contents
itemprototype.get
Description
integer/array itemprototype.get(object parameters)
La méthode permet de récupérer des prototypes d'éléments en fonction des paramètres donnés.
Cette méthode est disponible à tous les types d'utilisateurs. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres du le rôle d'utilisateur. Voir Rôles Utilisateur pour plus d'informations.
Paramètres
(object) Paramètres définissant la sortie souhaitée.
La méthode prend en charge les paramètres suivants.
| Paramètre | Type | Description |
|---|---|---|
| discoveryids | string/array | Renvoie uniquement les prototypes d'éléments appartenant aux règles de découverte bas niveau données. |
| graphids | string/array | Renvoie uniquement les prototypes d'éléments utilisés dans les prototypes de graphique donnés. |
| hostids | string/array | Renvoie uniquement les prototypes d'éléments appartenant aux hôtes donnés. |
| inherited | boolean | Si défini à true, ne renvoie que les prototypes d'éléments hérités d'un modèle. |
| itemids | string/array | Renvoie uniquement les prototypes d'éléments avec les identifiants donnés. |
| monitored | boolean | Si défini à true, ne renvoie que les prototypes d'éléments activés appartenant aux hôtes surveillés. |
| templated | boolean | Si défini à true, ne renvoie que les prototypes d'éléments appartenant aux modèles. |
| templateids | string/array | Renvoie uniquement les prototypes d'éléments appartenant aux modèles donnés. |
| triggerids | string/array | Renvoie uniquement les prototypes d'éléments utilisés dans les prototypes de déclencheur donnés. |
| selectDiscoveryRule | query | Renvoie une propriété discoveryRule contenant la règle de découverte bas niveau qui a créé le prototype d'élément. |
| selectGraphs | query | Renvoie une propriété graphs contenant les prototypes de graphique utilisant le prototype d'élément. Supporte count. |
| selectHosts | query | Renvoie une propriété hosts contenant un tableau d'hôtes auxquels le prototype d'élément appartient. |
| selectTags | query | Renvoie les tags de prototype d'élément dans la propriété tags. |
| selectTriggers | query | Renvoie une propriété triggers contenant les prototypes de déclencheur qui utilisent ce prototype d'élément. Supporte count. |
| selectPreprocessing | query | Renvoie les options de pré-traitement des éléments dans la propriété preprocessing.Il a les propriétés suivantes : type - (string) Les types d'option de pré-traitement :1 - Multiplicateur personnalisé ; 2 - Suppression des espaces à droite ; 3 - Suppression des espaces à gauche ; 4 - Suppression des espaces à droite et à gauche ; 5 - Correspondance d'expression régulière ; 6 - Booléen vers décimal ; 7 - Octal vers décimal ; 8 - Hexadécimal vers décimal ; 9 - Changement simple ; 10 - Changement par seconde ; 11 - XML XPath; 12 - JSONPath; 13 - Dans l'interval ; 14 - Correspond à l'expression régulière ; 15 - Ne correspond pas à l'expression régulière ; 16 - Rechercher une erreur dans JSON ; 17 - Rechercher une erreur dans XML ; 18 - Rechercher une erreur à l'aide d'une expression régulière ;< br>19 - Supprimer sans modification ; 20 - Supprimer sans modification avec heartbeat ; 21 - JavaScript ; 22 - Motif Prometheus ; 23 - Prometheus vers JSON ; 24 - CSV vers JSON ; 25 - Remplacer ; 26 - Vérifier les valeurs non prises en charge ; 27 - XML vers JSON. params - (string) Paramètres supplémentaires utilisés par l'option de prétraitement. Plusieurs paramètres sont séparés par un caractère LF (\n).error_handler - (string) Type d'action utilisé en cas d'échec de l'étape de prétraitement :0 - Le message d'erreur est défini par le serveur Zabbix ; 1 - Supprimer la valeur ; 2 - Définir la valeur personnalisée ; 3 - Définir le message d'erreur personnalisé. error_handler_params - (string) Paramètres du gestionnaire d'erreurs. |
| selectValueMap | query | Renvoie une propriété valuemap contenant la table de correspondance de valeurs du prototype d'élément. |
| filter | object | Renvoie uniquement les résultats qui correspondent exactement au filtre donné. Accepte un tableau dans lequel les clés sont des noms de propriétés et les valeurs sont une valeur unique ou un tableau de valeurs à comparer. Prend en charge des filtres supplémentaires : host - nom technique de l'hôte auquel le prototype d'élément appartient |
| limitSelects | integer | Limite le nombre d'enregistrements renvoyés par les sous-requêtes. S'applique aux sous-requêtes suivantes : selectGraphs - les résultats seront triés par name ;selectTriggers - les résultats seront triés par description. |
| sortfield | string/array | Trie le résultat par les propriétés données. Les valeurs possibles sont : itemid, name, key_, delay, type et status. |
| countOutput | boolean | Ces paramètres, communs à toutes les méthodes get, sont décrits dans les commentaires de référence. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valeurs retournées
(integer/array) Retourne soit :
- un tableau d'objets ;
- le nombre d'objets récupérés, si le paramètre
countOutputa été utilisé.
Exemples
Récupération des prototypes d'éléments à partir d'une règle LLD
Récupérez tous les prototypes d'éléments pour un ID de règle LLD spécifique.
Requête :
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"output": "extend",
"discoveryids": "27426"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Réponse :
{
"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",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"interfaceid": "0",
"description": "",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"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": "",
"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": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"interfaceid": "0",
"description": "The processor load is calculated as system CPU load divided by number of CPU cores.",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"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",
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"discover": "0",
"uuid": "",
"parameters": []
}
],
"id": 1
}Recherche d'un élément dépendant
Trouvez un élément dépendant pour l'élément avec l'ID "25545".
Requête :
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"filter": {
"type": "18",
"master_itemid": "25545"
},
"limit": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Réponse :
{
"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": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"interfaceid": "0",
"description": "",
"evaltype": "0",
"master_itemid": "25545",
"jmx_endpoint": "",
"timeout": "3s",
"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": "",
"parameters": []
}
],
"id": 1
}Recherche du prototype d'élément d'agent HTTP
Recherchez le prototype d'élément d'agent HTTP avec la méthode de requête HEAD pour un ID d'hôte spécifique.
Requête :
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"hostids": "10254",
"filter": {
"type": "19",
"request_method": "3"
}
},
"id": 17,
"auth": "d678e0b85688ce578ff061bd29a20d3b"
}Réponse :
{
"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": "",
"logtimefmt": "",
"templateid": "28255",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"interfaceid": "2",
"description": "",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"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": "",
"parameters": []
}
],
"id": 17
}Voir également
Source
CItemPrototype::get() dans ui/include/classes/api/services/CItemPrototype.php.