Sommaire
item.get
Description
integer/array item.get(object parameters)
La méthode permet de récupérer des éléments selon les paramètres fournis.
Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d'appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Consultez 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.
| Parameter | Type | Description |
|---|---|---|
| itemids | ID/array | Ne retourner que les éléments avec les IDs donnés. |
| groupids | ID/array | Ne retourner que les éléments qui appartiennent aux hôtes des groupes donnés. |
| templateids | ID/array | Ne retourner que les éléments qui appartiennent aux modèles donnés. |
| hostids | ID/array | Ne retourner que les éléments qui appartiennent aux hôtes donnés. |
| proxyids | ID/array | Ne retourner que les éléments surveillés par les proxies donnés. |
| interfaceids | ID/array | Ne retourner que les éléments qui utilisent les interfaces d'hôte données. |
| graphids | ID/array | Ne retourner que les éléments utilisés dans les graphiques donnés. |
| triggerids | ID/array | Ne retourner que les éléments utilisés dans les déclencheurs donnés. |
| webitems | flag | Inclure les éléments web dans le résultat. |
| inherited | boolean | Si défini sur true, ne retourner que les éléments hérités d'un modèle. |
| templated | boolean | Si défini sur true, ne retourner que les éléments qui appartiennent à des modèles. |
| monitored | boolean | Si défini sur true, ne retourner que les éléments activés qui appartiennent à des hôtes surveillés. |
| group | string | Ne retourner que les éléments qui appartiennent à un groupe portant le nom donné. |
| host | string | Ne retourner que les éléments qui appartiennent à un hôte portant le nom donné. |
| evaltype | integer | Méthode d'évaluation des balises. Valeurs possibles : 0 - (par défaut) Et/Ou; 2 - Ou. |
| tags | array | Ne retourner que les éléments avec les balises données. Format : [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Un tableau vide retourne tous les éléments. Valeurs possibles de operator : 0 - (par défaut) Contient; 1 - Égal à; 2 - Ne contient pas; 3 - N'est pas égal à; 4 - Existe; 5 - N'existe pas. |
| with_triggers | boolean | Si défini sur true, ne retourner que les éléments utilisés dans des déclencheurs. |
| selectHosts | query | Retourne une propriété hosts avec un tableau d'hôtes auxquels l'élément appartient. |
| selectInterfaces | query | Retourne une propriété interfaces avec un tableau d'interfaces d'hôte utilisées par l'élément. |
| selectTriggers | query | Retourne une propriété triggers avec les déclencheurs dans lesquels l'élément est utilisé.Prend en charge count. |
| selectGraphs | query | Retourne une propriété graphs avec les graphiques qui contiennent l'élément.Prend en charge count. |
| selectDiscoveryRule | query | Retourne une propriété discoveryRule avec la règle LLD qui a créé l'élément. |
| selectItemDiscovery | query | Retourne une propriété itemDiscovery avec l'objet de découverte d'élément. L'objet de découverte d'élément relie l'élément au prototype d'élément à partir duquel il a été créé.Il possède les propriétés suivantes : itemdiscoveryid - (string) ID de la découverte d'élément;itemid - (string) ID de l'élément découvert;parent_itemid - (string) ID du prototype d'élément à partir duquel l'élément a été créé;key_ - (string) clé du prototype d'élément;lastcheck - (timestamp) heure à laquelle l'élément a été découvert pour la dernière fois;status - (int) statut de découverte de l'élément :0 - (par défaut) l'élément est découvert, 1 - l'élément n'est plus découvert; ts_delete - (timestamp) heure à laquelle un élément qui n'est plus découvert sera supprimé;ts_disable - (timestamp) heure à laquelle un élément qui n'est plus découvert sera désactivé;disable_source - (int) indicateur précisant si l'élément a été désactivé par une règle LLD ou manuellement :0 - (par défaut) désactivé automatiquement, 1 - désactivé par une règle LLD. |
| selectPreprocessing | query | Retourne une propriété preprocessing avec les options de prétraitement de l'élément. |
| selectTags | query | Retourne les balises de l'élément dans la propriété tags. |
| selectValueMap | query | Retourne une propriété valuemap avec la correspondance de valeurs de l'élément. |
| filter | object | Ne retourner que les résultats qui correspondent exactement au filtre donné. Accepte un objet, où les clés sont des noms de propriétés et les valeurs sont soit une valeur unique, soit un tableau de valeurs à comparer. Ne prend pas en charge les propriétés de type de données data type text.Prend en charge des propriétés supplémentaires : host - nom technique de l'hôte auquel l'élément appartient. |
| limitSelects | integer | Limite le nombre d'enregistrements renvoyés par les sous-sélections. S'applique aux sous-sélections suivantes : selectGraphs - les résultats seront triés par name;selectTriggers - les résultats seront triés par description. |
| sortfield | string/array | Trier le résultat selon les propriétés données. Valeurs possibles : itemid, name, key_, delay, history, trends, type, status. |
| countOutput | boolean | Ces paramètres sont décrits dans le commentaire de référence. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valeurs de retour
(integer/array) Renvoie soit :
- un tableau d'objets ;
- le nombre d'objets récupérés, si le paramètre
countOutputa été utilisé.
Exemples
Recherche d'éléments par clé
Récupère tous les éléments utilisés dans les déclencheurs pour un ID d'hôte spécifique qui contiennent le mot "system.cpu" dans la clé de l'élément et trie les résultats par nom.
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10084",
"with_triggers": true,
"search": {
"key_": "system.cpu"
},
"sortfield": "name"
},
"id": 1
}Réponse:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "42269",
"type": "18",
"snmp_oid": "",
"hostid": "10084",
"name": "Utilisation CPU",
"key_": "system.cpu.util",
"delay": "0",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "%",
"logtimefmt": "",
"templateid": "42267",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "Utilisation CPU en %.",
"inventory_link": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "42264",
"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",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"name_resolved": "Utilisation CPU"
},
{
"itemid": "42259",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Charge moyenne (moyenne 15 min)",
"key_": "system.cpu.load[all,avg15]",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "42219",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"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",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"name_resolved": "Charge moyenne (moyenne 15 min)"
},
{
"itemid": "42249",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Charge moyenne (moyenne 1 min)",
"key_": "system.cpu.load[all,avg1]",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "42209",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"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",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"name_resolved": "Charge moyenne (moyenne 1 min)"
},
{
"itemid": "42257",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Charge moyenne (moyenne 5 min)",
"key_": "system.cpu.load[all,avg5]",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "42217",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"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",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"name_resolved": "Charge moyenne (moyenne 5 min)"
},
{
"itemid": "42260",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Nombre de CPU",
"key_": "system.cpu.num",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "42220",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"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",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"name_resolved": "Nombre de CPU"
}
],
"id": 1
}Recherche d'éléments dépendants par clé
Récupérez tous les éléments dépendants de l'hôte avec l'ID "10116" qui contiennent le mot "apache" dans la clé.
Requête :
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10116",
"search": {
"key_": "apache"
},
"filter": {
"type": 18
}
},
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "25550",
"type": "18",
"snmp_oid": "",
"hostid": "10116",
"name": "Days",
"key_": "apache.status.uptime.days",
"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": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"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",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"name_resolved": "Days"
},
{
"itemid": "25555",
"type": "18",
"snmp_oid": "",
"hostid": "10116",
"name": "Hours",
"key_": "apache.status.uptime.hours",
"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": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"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",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"name_resolved": "Hours"
}
],
"id": 1
}Trouver un élément HTTP agent
Trouver un élément HTTP agent avec un type de corps de requête XML pour un ID d'hôte spécifique.
Requête :
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"hostids": "10255",
"filter": {
"type": 19,
"post_type": 3
}
},
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "28252",
"type": "19",
"snmp_oid": "",
"hostid": "10255",
"name": "élément du modèle",
"key_": "ti",
"delay": "30s",
"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": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "",
"url": "localhost",
"query_fields": [
{
"name": "mode",
"value": "xml"
}
],
"posts": "<body>\r\n<![CDATA[{$MACRO}<foo></bar>]]>\r\n</body>",
"status_codes": "200",
"follow_redirects": "0",
"post_type": "3",
"http_proxy": "",
"headers": [],
"retrieve_mode": "1",
"request_method": "3",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "",
"prevvalue": "",
"name_resolved": "élément du modèle"
}
],
"id": 1
}Récupération des éléments avec des règles de prétraitement
Récupérez tous les éléments et leurs règles de prétraitement pour un ID d'hôte spécifique.
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": ["itemid", "name", "key_"],
"selectPreprocessing": "extend",
"hostids": "10254"
},
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": {
"itemid": "23865",
"name": "HTTP agent example JSON",
"key_": "json",
"preprocessing": [
{
"type": "12",
"params": "$.random",
"error_handler": "1",
"error_handler_params": ""
}
]
},
"id": 1
}Voir aussi
Source
CItem::get() dans ui/include/classes/api/services/CItem.php.