Documentation
Table of Contents
graphprototype.get
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
entero/matriz graphprototype.get(par¨¢metros de objeto)
El m¨¦todo permite recuperar prototipos de gr¨¢ficos 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.
±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ
(objeto) ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ que definen la salida deseada.
El m¨¦todo admite los siguientes par¨¢metros.
| ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| discoveryids | cadena/matriz | Devuelve solo prototipos de gr¨¢ficos que pertenecen a las reglas de descubrimiento dadas. |
| graphids | cadena/matriz | Devuelve solo prototipos de gr¨¢ficos con los ID proporcionados. |
| groupids | cadena/matriz | Devuelve solo prototipos de gr¨¢ficos que pertenecen a equipos en los grupos de equipos dados. |
| hostids | cadena/matriz | Devuelve solo prototipos de gr¨¢ficos que pertenecen a los equipos dados. |
| inherited | booleano | Si se establece en "verdadero", devuelve solo los prototipos de gr¨¢ficos heredados de una plantilla. |
| itemids | cadena/matriz | Devuelve solo prototipos de gr¨¢ficos que contienen los prototipos de ³¾¨¦³Ù°ù¾±³¦²¹²õ dados. |
| templated | booleano | Si se establece en "verdadero", devuelve solo prototipos de gr¨¢ficos que pertenecen a plantillas. |
| templateids | cadena/matriz | Devuelve solo prototipos de gr¨¢ficos que pertenecen a las plantillas dadas. |
| selectDiscoveryRule | query | Devuelve una propiedad discoveryRule con la regla LLD a la que pertenece el prototipo de gr¨¢fico. |
| selectGraphItems | query | Devuelve una propiedad gitems con los elementos del gr¨¢fico utilizados en el prototipo del gr¨¢fico. |
| selectGroups | query | Devuelve una propiedad groups con los grupos de equipos a los que pertenece el prototipo de gr¨¢fico. |
| selectHosts | query | Devuelve una propiedad hosts con los equipos a los que pertenece el prototipo del gr¨¢fico. |
| selectItems | query | Devuelve una propiedad items con las ³¾¨¦³Ù°ù¾±³¦²¹²õ y prototipos de ³¾¨¦³Ù°ù¾±³¦²¹²õ usados en el prototipo del gr¨¢fico . |
| selectTemplates | query | Devuelve una propiedad templates con las plantillas a las que pertenece el prototipo de gr¨¢fico. |
| filter | objeto | Devuelve s¨®lo aquellos resultados que coinciden exactamente con el filtro dado. Acepta una matriz, donde las claves son nombres de propiedades y los valores son un valor ¨²nico o una matriz de valores con los que comparar. Admite filtros adicionales: host: nombre t¨¦cnico del equipo al que pertenece el prototipo del gr¨¢fico;hostid: ID del equipo al que pertenece el prototipo del gr¨¢fico. |
| sortfield | string/array | Ordena el resultado seg¨²n las propiedades dadas. Los valores posibles son: graphid, name y graphtype. |
| countOutput | booleano | Estos par¨¢metros, que son comunes para todos los m¨¦todos get, se describen detalladamente en el comentario de referencia. |
| editable | booleano | |
| excludeSearch | booleano | |
| limit | entero | |
| output | consulta | |
| preservekeys | booleano | |
| search | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | cadena/matriz | |
| startSearch | booleano |
Valores de retorno
(entero/matriz) Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el par¨¢metro
countOutputha sido usado.
Ejemplos
Recuperaci¨®n de prototipos de gr¨¢ficos a partir de una regla LLD
Recuperar todos los prototipos de gr¨¢ficos a partir de una regla LLD.
Solicitud:
{
"jsonrpc": "2.0",
"method": "graphprototype.get",
"params": {
"output": "extend",
"discoveryids": "27426"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"graphid": "1017",
"parent_itemid": "27426",
"name": "Disk space usage {#FSNAME}",
"width": "600",
"height": "340",
"yaxismin": "0.0000",
"yaxismax": "0.0000",
"templateid": "442",
"show_work_period": "0",
"show_triggers": "0",
"graphtype": "2",
"show_legend": "1",
"show_3d": "1",
"percent_left": "0.0000",
"percent_right": "0.0000",
"ymin_type": "0",
"ymax_type": "0",
"ymin_itemid": "0",
"ymax_itemid": "0",
"discover": "0"
}
],
"id": 1
}Ver tambi¨¦n
Fuente
CGraphPrototype::get() en ui/include/classes/api/services/CGraphPrototype.php.