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

(object) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parameter Type Description
discoveryids ID/array Devuelve solo prototipos de item que pertenecen a las reglas LLD indicadas.
graphids ID/array Devuelve solo prototipos de item que se usan en los prototipos de gráfico indicados.
hostids ID/array Devuelve solo prototipos de item que pertenecen a los hosts indicados.
inherited boolean Si se establece en true, devuelve solo prototipos de item heredados de un template.
itemids ID/array Devuelve solo prototipos de item con los IDs indicados.
monitored boolean Si se establece en true, devuelve solo prototipos de item habilitados que pertenecen a hosts monitorizados.
templated boolean Si se establece en true, devuelve solo prototipos de item que pertenecen a templates.
templateids ID/array Devuelve solo prototipos de item que pertenecen a los templates indicados.
triggerids ID/array Devuelve solo prototipos de item que se usan en los prototipos de trigger indicados.
selectDiscoveryData query Devuelve una propiedad discoveryData con los datos del objeto de descubrimiento del prototipo de item. El objeto de descubrimiento del prototipo de item vincula un prototipo de item descubierto con un prototipo de item a partir del cual se descubrió.

Tiene las siguientes propiedades:
parent_itemid - (string) ID del prototipo de item a partir del cual se ha creado el prototipo de item;
key_ - (string) clave del prototipo de item;
status - (int) estado de descubrimiento del prototipo de item:
0 - (predeterminado) el prototipo de item está descubierto,
1 - el prototipo de item ya no está descubierto;
ts_delete - (timestamp) momento en que se eliminará un prototipo de item que ya no está descubierto;
ts_disable - (timestamp) momento en que se deshabilitará un prototipo de item que ya no está descubierto;
disable_source - (int) indicador de si el prototipo de item fue deshabilitado por una regla LLD o manualmente:
0 - (predeterminado) deshabilitado automáticamente,
1 - deshabilitado por una regla LLD.
selectDiscoveryRule query Devuelve una propiedad discoveryRule con la regla de descubrimiento de bajo nivel a la que pertenece el prototipo de item.
selectDiscoveryRulePrototype query Devuelve una propiedad discoveryRulePrototype con el prototipo de regla LLD padre al que pertenece el prototipo de item.
selectGraphs query Devuelve una propiedad graphs con los prototipos de gráfico en los que se usa el prototipo de item.

Admite count.
selectHosts query Devuelve una propiedad hosts con un array de hosts al que pertenece el prototipo de item.
selectTags query Devuelve las etiquetas del prototipo de item en la propiedad tags.
selectTriggers query Devuelve una propiedad triggers con los prototipos de trigger en los que se usa el prototipo de item.

Admite count.
selectPreprocessing query Devuelve una propiedad preprocessing con las opciones de preprocesamiento del prototipo de item.
selectValueMap query Devuelve una propiedad valuemap con el mapa de valores del prototipo de item.
filter object Devuelve solo los resultados que coinciden exactamente con el filtro indicado.

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 del tipo de datos text data type.

Admite propiedades adicionales:
host - nombre técnico del host al que pertenece el prototipo de item.
limitSelects integer Limita el número de registros devueltos por las subconsultas.

Se aplica a las siguientes subconsultas:
selectGraphs - los resultados se ordenarán por name;
selectTriggers - los resultados se ordenarán por description.
sortfield string/array Ordena el resultado por las propiedades indicadas.

Valores posibles: itemid, name, key_, delay, type, status, history, trends, discovered.
countOutput boolean Estos parámetros se describen en el comentario de referencia.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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 item de una regla LLD

Recupere todos los prototipos de item para un ID de regla LLD específico.

Solicitud:

{
    "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": "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": "",
            "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 minuto 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 item dependiente

Encuentre un item dependiente para un ID de item específico.

Solicitud:

{
    "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
}

Encontrar prototype de item de HTTP agent

Encontrar prototype de item de HTTP agent con método de solicitud HEAD para un ID de host específico.

Solicitud:

{
    "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
}

Ver también

Fuente

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