itemprototype.get

Descripción

integer/array itemprototype.get(object parameters)

El método permite recuperar prototipos de métrica de acuerdo con los parámetros dados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se pueden revocar en la configuración de roles de usuario. Ver Roles de usuario para 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 item que pertenecen a las reglas LLD indicadas.
graphids ID/array Devolver solo los prototipos de item que se utilizan en los prototipos de gráfico indicados.
hostids ID/array Devolver solo los prototipos de item que pertenecen a los hosts indicados.
inherited boolean Si se establece en true, devolver solo los prototipos de item heredados de una template.
itemids ID/array Devolver solo los prototipos de item con los IDs indicados.
monitored boolean Si se establece en true, devolver solo los prototipos de item habilitados que pertenecen a hosts monitorizados.
templated boolean Si se establece en true, devolver solo los prototipos de item que pertenecen a templates.
templateids ID/array Devolver solo los prototipos de item que pertenecen a las templates indicadas.
triggerids ID/array Devolver solo 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 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 - (por defecto) el prototipo de item está descubierto,
1 - el prototipo de item ya no se descubre;
ts_delete - (timestamp) hora en la que se eliminará un prototipo de item que ya no se descubre;
ts_disable - (timestamp) hora en la que se deshabilitará un prototipo de item que ya no se descubre;
disable_source - (int) indicador de si el prototipo de item fue deshabilitado por una regla LLD o manualmente:
0 - (por defecto) 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.
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 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 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 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 devueltos

(integer/array) Returns either:

  • una matriz de objetos;
  • la suma de los objetos devueltos, si el parámetros countOutput está siendo usado

Ejemplos

Recuperar prototipos de métricas de una regla LLD

Recupere todos los prototipos de métricas para una ID de regla LLD específica.

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": "",
            "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": "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": "",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "interfaceid": "0",
            "description": "The processor load is calculated as system CPU load divided by number of CPU cores.",
            "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

Busque una métrica dependiente para una ID de métrica específica.

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": "",
            "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 elemento de agente HTTP

Encuentre el prototipo del elemento del agente HTTP con el método de solicitud HEAD para una ID de host específica.

Solicitud:

{
    "jsonrpc": "2.0",
    "método": "itemprototype.get",
    "parámetros": {
        "hostids": "10254",
        "filtro": {
            "tipo": 19,
            "método_solicitud": 3
        }
    },
    "identificación": 1
}

Respuesta:

{
    "jsonrpc": "2.0",
    "resultado": [
        {
            "itemid": "28257",
            "tipo": "19",
            "snmp_oid": "",
            "hostid": "10254",
            "nombre": "descubierto",
            "key_": "elemento[{#INAME}]",
            "retraso": "{#IUPDATE}",
            "historia": "90d",
            "tendencias": "30d",
            "estado": "0",
            "tipo_valor": "3",
            "trapper_hosts": "",
            "unidades": "",
            "logtimefmt": "",
            "templateid": "28255",
            "valormapid": "0",
            "parámetros": "",
            "ipmi_sensor": "",
            "tipo de autenticación": "0",
            "nombre de usuario": "",
            "contraseña": "",
            "Llave pública": "",
            "llave privada": "",
            "banderas": "2",
            "interfaceid": "2",
            "descripción": "",
            "tipo de evaluación": "0",
            "jmx_endpoint": "",
            "master_itemid": "0",
            "se acabó el tiempo": "",
            "url": "{#IURL}",
            "campos_de consulta": [],
            "publicaciones": "",
            "códigos_estado": "",
            "follow_redirects": "0",
            "tipo_post": "0",
            "http_proxy": "",
            "encabezados": [],
            "retrieve_mode": "0",
            "request_method": "3",
            "output_format": "0",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verificar_host": "0",
            "allow_traps": "0",
            "descubrir": "0",
            "uuid": "",
            "parámetros": []
        }
    ],
    "identificación": 1
}

Ver también

Fuente

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