[comment]: # ({58fbd3bc-58fbd3bc}) # item.get [comment]: # ({/58fbd3bc-58fbd3bc}) [comment]: # ({14484745-673edf7f}) ### Description `integer/array item.get(object parameters)` La méthode permet de récupérer des éléments selon les paramètres fournis. ::: noteclassic 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. Voir [User roles](/manual/web_interface/frontend_sections/users/user_roles) pour plus d'informations. ::: [comment]: # ({/14484745-673edf7f}) [comment]: # ({641397fb-cc946363}) ### Paramètres `(object)` Paramètres définissant la sortie souhaitée. La méthode prend en charge les paramètres suivants. |Parameter|[Type](/manual/api/reference_commentary#data-types)|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](/manual/web_interface/frontend_sections/data_collection/hosts/items#using-filter).

Valeurs possibles :
0 - *(par défaut)* And/Or;
2 - Or.| |tags|array|Ne retourner que les éléments avec les balises données.
Format : `[{"tag": "", "value": "", "operator": ""}, ...]`.
Un tableau vide retourne tous les éléments.

Valeurs possibles de [operator](/manual/web_interface/frontend_sections/data_collection/hosts/items#using-filter) :
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|Retourner une propriété [`hosts`](/manual/api/reference/host/object) contenant un tableau des hôtes auxquels l'élément appartient.| |selectInterfaces|query|Retourner une propriété [`interfaces`](/manual/api/reference/hostinterface/object) contenant un tableau des interfaces d'hôte utilisées par l'élément.| |selectTriggers|query|Retourner une propriété [`triggers`](/manual/api/reference/trigger/object) contenant les déclencheurs dans lesquels l'élément est utilisé.

Prend en charge `count`.| |selectGraphs|query|Retourner une propriété [`graphs`](/manual/api/reference/graph/object) contenant les graphiques qui incluent l'élément.

Prend en charge `count`.| |selectDiscoveryData|query|Retourner une propriété `discoveryData` contenant les données de l'objet de découverte de l'élément. L'objet de découverte de l'élément lie un élément découvert à un prototype d'élément à partir duquel il a été découvert.

Il possède les propriétés suivantes :
`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;
`status` - `(int)` état 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)` moment où un élément qui n'est plus découvert sera supprimé;
`ts_disable` - `(timestamp)` moment où 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.| |selectDiscoveryRule|query|Retourner une propriété [`discoveryRule`](/manual/api/reference/discoveryrule/object) contenant la règle LLD qui a créé l'élément.| |selectPreprocessing|query|Retourner une propriété [`preprocessing`](/manual/api/reference/item/object#item-preprocessing) contenant les options de prétraitement de l'élément.| |selectTags|query|Retourner les balises de l'élément dans la propriété [`tags`](/manual/api/reference/item/object#item-tag).| |selectValueMap|query|Retourner une propriété [`valuemap`](/manual/api/reference/valuemap/object) contenant 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 `text` [data type](/manual/api/reference_commentary#data-types).

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](/manual/api/reference_commentary#common-get-method-parameters).| |editable|boolean|^| |excludeSearch|boolean|^| |limit|integer|^| |output|query|^| |preservekeys|boolean|^| |search|object|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |sortorder|string/array|^| |startSearch|boolean|^| |selectItemDiscovery|query|Retourner une propriété `itemDiscovery` contenant l'objet de découverte de l'élément. L'objet de découverte de l'élément lie l'élément à un prototype d'élément à partir duquel il a été créé.

Cette requête est **obsolète** ; veuillez utiliser `selectDiscoveryData` à la place.| [comment]: # ({/641397fb-cc946363}) [comment]: # ({7223bab1-7223bab1}) ### Valeurs de retour `(integer/array)` Renvoie soit : - un tableau d'objets ; - le nombre d'objets récupérés, si le paramètre `countOutput` a été utilisé. [comment]: # ({/7223bab1-7223bab1}) [comment]: # ({b41637d2-b41637d2}) ### Exemples [comment]: # ({/b41637d2-b41637d2}) [comment]: # ({1a09225b-59b84d93}) #### 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. [Request](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "item.get", "params": { "output": "extend", "hostids": "10084", "with_triggers": true, "search": { "key_": "system.cpu" }, "sortfield": "name" }, "id": 1 } ``` Réponse: ```json { "jsonrpc": "2.0", "result": [ { "itemid": "42269", "type": "18", "snmp_oid": "", "hostid": "10084", "name": "CPU utilization", "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": "CPU utilization in %.", "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": "CPU utilization" }, { "itemid": "42259", "type": "0", "snmp_oid": "", "hostid": "10084", "name": "Load average (15m avg)", "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": "Load average (15m avg)" }, { "itemid": "42249", "type": "0", "snmp_oid": "", "hostid": "10084", "name": "Load average (1m avg)", "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": "Load average (1m avg)" }, { "itemid": "42257", "type": "0", "snmp_oid": "", "hostid": "10084", "name": "Load average (5m avg)", "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": "Load average (5m avg)" }, { "itemid": "42260", "type": "0", "snmp_oid": "", "hostid": "10084", "name": "Number of CPUs", "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": "Number of CPUs" } ], "id": 1 } ``` [comment]: # ({/1a09225b-59b84d93}) [comment]: # ({a6ae1426-674b0856}) #### 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](/manual/api#performing-requests) : ```json { "jsonrpc": "2.0", "method": "item.get", "params": { "output": "extend", "hostids": "10116", "search": { "key_": "apache" }, "filter": { "type": 18 } }, "id": 1 } ``` Réponse : ```json { "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 } ``` [comment]: # ({/a6ae1426-674b0856}) [comment]: # ({256e2a05-94dc4b21}) #### Trouver un élément d'agent HTTP Trouver un élément d'agent HTTP avec un type de corps de requête XML pour un ID d'hôte spécifique. [Requête](/manual/api#performing-requests) : ```json { "jsonrpc": "2.0", "method": "item.get", "params": { "hostids": "10255", "filter": { "type": 19, "post_type": 3 } }, "id": 1 } ``` Réponse : ```json { "jsonrpc": "2.0", "result": [ { "itemid": "28252", "type": "19", "snmp_oid": "", "hostid": "10255", "name": "template item", "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": "\r\n]]>\r\n", "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": "template item" } ], "id": 1 } ``` [comment]: # ({/256e2a05-94dc4b21}) [comment]: # ({6697de6d-f4b01bbe}) #### 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. [Requête](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "item.get", "params": { "output": ["itemid", "name", "key_"], "selectPreprocessing": "extend", "hostids": "10254" }, "id": 1 } ``` Réponse : ```json { "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 } ``` [comment]: # ({/6697de6d-f4b01bbe}) [comment]: # ({8d9fbd3b-d3276b35}) ### Voir aussi - [Règle de découverte](/manual/api/reference/discoveryrule/object#discovery-rule) - [Graphique](/manual/api/reference/graph/object#graph) - [Hôte](/manual/api/reference/host/object#host) - [Interface d'hôte](/manual/api/reference/hostinterface/object#host-interface) - [Déclencheur](/manual/api/reference/trigger/object#trigger) [comment]: # ({/8d9fbd3b-d3276b35}) [comment]: # ({a6ef1d0f-a6ef1d0f}) ### Source CItem::get() dans *ui/include/classes/api/services/CItem.php*. [comment]: # ({/a6ef1d0f-a6ef1d0f})