itemprototype.get

Descripción

integer/array itemprototype.get(object parameters)

El método permite recuperar prototipos de item según los parámetros proporcionados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden revocarse 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 el resultado deseado.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
discoveryids ID/array Devuelve únicamente los prototipos de item que pertenecen a las reglas LLD indicadas.
graphids ID/array Devuelve únicamente los prototipos de item que se utilizan en los prototipos de gráfico indicados.
hostids ID/array Devuelve únicamente los prototipos de item que pertenecen a los hosts indicados.
inherited boolean Si se establece en true, devuelve únicamente los prototipos de item heredados de un template.
itemids ID/array Devuelve únicamente los prototipos de item con los ID indicados.
monitored boolean Si se establece en true, devuelve únicamente los prototipos de item habilitados que pertenecen a hosts monitorizados.
templated boolean Si se establece en true, devuelve únicamente los prototipos de item que pertenecen a templates.
templateids ID/array Devuelve únicamente los prototipos de item que pertenecen a los templates indicados.
triggerids ID/array Devuelve únicamente los prototipos de item que se utilizan 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 el 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 creó 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 principal al que pertenece el prototipo de item.
selectGraphs query Devuelve una propiedad graphs con los prototipos de gráfico en los que se utiliza el prototipo de item.

Admite count.
selectHosts query Devuelve una propiedad hosts con un array de hosts a los que pertenece el prototipo de item.
selectInheritedTags query Devuelve una propiedad inheritedTags con las etiquetas presentes en el template, el host o los templates vinculados.
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 utiliza 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 únicamente los resultados que coinciden exactamente con el filtro indicado.

Acepta un objeto cuyas claves son nombres de propiedades y cuyos valores son un único valor o un array de valores con los que se debe comparar.

No admite propiedades del tipo de datos text.

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 subselecciones.

Se aplica a las siguientes subselecciones:
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 los comentarios 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

Recuperar 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",
            "formula": "",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "2",
            "interfaceid": "0",
            "description": "",
            "inventory_link": "0",
            "lifetime": "7d",
            "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": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "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": "",
            "formula": "",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "2",
            "interfaceid": "0",
            "description": "The processor load is calculated as system CPU load divided by number of CPU cores.",
            "inventory_link": "0",
            "lifetime": "7d",
            "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": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "parameters": []
        }
    ],
    "id": 1
}

Buscar un item dependiente

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

Solicitud:

{
    "jsonrpc": "2.0",
    "method": "itemprototype.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": "",
            "formula": "",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "0",
            "interfaceid": "0",
            "description": "",
            "inventory_link": "0",
            "lifetime": "7d",
            "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",
            "discover": "0",
            "uuid": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "parameters": []
        }
    ],
    "id": 1
}

Buscar prototipo de item HTTP agent

Buscar prototipo de item 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": "",
            "formula": "",
            "logtimefmt": "",
            "templateid": "28255",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "2",
            "interfaceid": "2",
            "description": "",
            "inventory_link": "0",
            "lifetime": "7d",
            "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": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "parameters": []
        }
    ],
    "id": 1
}

Ver también

Fuente

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