Table of Contents
itemprototype.get
Descripción
integer/array itemprototype.get(object parameters)
El método permite recuperar prototipos de métricas según los parámetros proporcionados.
Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en la configuración de roles de usuario. Consulte Roles de usuario para obtener más información.
Parámetros
(objeto) Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
| Parámetro | Tipo | Descripción |
|---|---|---|
| discoveryids | ID/array | Devolver solo los prototipos de ítem que pertenecen a las reglas LLD indicadas. |
| graphids | ID/array | Devolver solo los prototipos de ítem que se utilizan en los prototipos de gráfico indicados. |
| hostids | ID/array | Devolver solo los prototipos de ítem que pertenecen a los hosts indicados. |
| inherited | booleano | Si se establece en true, devolver solo los prototipos de ítem heredados de una plantilla. |
| itemids | ID/array | Devolver solo los prototipos de ítem con los IDs indicados. |
| monitored | booleano | Si se establece en true, devolver solo los prototipos de ítem habilitados que pertenecen a hosts monitorizados. |
| templated | booleano | Si se establece en true, devolver solo los prototipos de ítem que pertenecen a plantillas. |
| templateids | ID/array | Devolver solo los prototipos de ítem que pertenecen a las plantillas indicadas. |
| triggerids | ID/array | Devolver solo los prototipos de ítem que se utilizan en los prototipos de disparador indicados. |
| selectDiscoveryData | consulta | Devuelve una propiedad discoveryData con los datos del objeto de descubrimiento del prototipo de ítem. El objeto de descubrimiento del prototipo de ítem vincula un prototipo de ítem descubierto con un prototipo de ítem del que fue descubierto.Tiene las siguientes propiedades: parent_itemid - (cadena) ID del prototipo de ítem del que se ha creado el prototipo de ítem;key_ - (cadena) clave del prototipo de ítem;status - (int) estado de descubrimiento del prototipo de ítem:0 - (por defecto) el prototipo de ítem está descubierto, 1 - el prototipo de ítem ya no está descubierto; ts_delete - (timestamp) hora en la que se eliminará un prototipo de ítem que ya no se descubre;ts_disable - (timestamp) hora en la que se deshabilitará un prototipo de ítem que ya no se descubre;disable_source - (int) indicador de si el prototipo de ítem fue deshabilitado por una regla LLD o manualmente:0 - (por defecto) deshabilitado automáticamente, 1 - deshabilitado por una regla LLD. |
| selectDiscoveryRule | consulta | Devuelve una propiedad discoveryRule con la regla de descubrimiento de bajo nivel a la que pertenece el prototipo de ítem. |
| selectDiscoveryRulePrototype | consulta | Devuelve una propiedad discoveryRulePrototype con el prototipo de regla LLD principal al que pertenece el prototipo de ítem. |
| selectGraphs | consulta | Devuelve una propiedad graphs con los prototipos de gráfico en los que se utiliza el prototipo de ítem.Admite count. |
| selectHosts | consulta | Devuelve una propiedad hosts con un array de hosts a los que pertenece el prototipo de ítem. |
| selectTags | consulta | Devuelve las etiquetas del prototipo de ítem en la propiedad tags. |
| selectTriggers | consulta | Devuelve una propiedad triggers con los prototipos de disparador en los que se utiliza el prototipo de ítem.Admite count. |
| selectPreprocessing | consulta | Devuelve una propiedad preprocessing con las opciones de preprocesamiento del prototipo de ítem. |
| selectValueMap | consulta | Devuelve una propiedad valuemap con el mapa de valores del prototipo de ítem. |
| filter | objeto | Devuelve solo aquellos resultados que coincidan exactamente con el filtro dado. Acepta un objeto, donde las claves son nombres de propiedades y los valores son un único valor o un array de valores con los que comparar. No admite propiedades de tipo de dato text data type.Admite propiedades adicionales: host - nombre técnico del host al que pertenece el prototipo de ítem. |
| limitSelects | entero | Limita el número de registros devueltos por subconsultas. Se aplica a las siguientes subconsultas: selectGraphs - los resultados se ordenarán por name;selectTriggers - los resultados se ordenarán por description. |
| sortfield | cadena/array | Ordena el resultado por las propiedades indicadas. Valores posibles: itemid, name, key_, delay, type, status, history, trends, discovered. |
| countOutput | booleano | Estos parámetros se describen en el comentario de referencia. |
| editable | booleano | |
| excludeSearch | booleano | |
| limit | entero | |
| output | consulta | |
| preservekeys | booleano | |
| search | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | cadena/array | |
| startSearch | booleano |
Valores de retorno
(integer/array) Devuelve:
- un array de objetos;
- el número de objetos recuperados, si se ha utilizado el parámetro
countOutput.
Ejemplos
Recuperar prototipos de métricas de una regla LLD
Recupera todos los prototipos de métricas para un ID de regla LLD específico.
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"output": "extend",
"discoveryids": "27426"
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "23077",
"type": "0",
"snmp_oid": "",
"hostid": "10079",
"name": "Tráfico de red entrante en 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": "",
"flags": "2",
"interfaceid": "0",
"description": "",
"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": "",
"parameters": []
},
{
"itemid": "10010",
"type": "0",
"snmp_oid": "",
"hostid": "10001",
"name": "Carga del procesador (promedio de 1 min por núcleo)",
"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": "",
"flags": "2",
"interfaceid": "0",
"description": "La carga del procesador se calcula como la carga de CPU del sistema dividida por el número de núcleos de CPU.",
"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": "",
"parameters": []
}
],
"id": 1
}Encontrar una métrica dependiente
Encontrar una métrica dependiente para un ID de métrica específico.
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"filter": {
"type": 18,
"master_itemid": "25545"
},
"limit": "1"
},
"id": 1
}Respuesta:
{
"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": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"evaltype": "0",
"master_itemid": "25545",
"jmx_endpoint": "",
"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": "",
"parameters": []
}
],
"id": 1
}Buscar prototipo de métrica HTTP agent
Buscar prototipo de métrica HTTP agent con método de solicitud HEAD para un ID de equipo específico.
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"hostids": "10254",
"filter": {
"type": 19,
"request_method": 3
}
},
"id": 1
}Respuesta:
{
"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": "",
"flags": "2",
"interfaceid": "2",
"description": "",
"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": "",
"parameters": []
}
],
"id": 1
}Véase también
Fuente
CItemPrototype::get() en ui/include/classes/api/services/CItemPrototype.php.