Documentation
Table of Contents
mediatype.get
Descripción
integer/array mediatype.get(object parameters)
El método permite recuperar tipos de medios según 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 |
|---|---|---|
| mediatypeids | ID/array | Devuelve solo tipos de medios con los ID proporcionados. |
| mediaids | ID/matriz | Devuelve solo los tipos de medios utilizados por el medio dado. |
| userids | ID/matriz | Devuelve solo los tipos de medios utilizados por los usuarios dados. |
| selectActions | query | Devuelve una propiedad actions con las acciones que utilizan el tipo de medio. |
| selectMessageTemplates | query | Devuelve una propiedad message_templates con una matriz de mensajes de tipo multimedia. |
| selectUsers | query | Devuelve una propiedad users con los usuarios que usan el tipo de medio. |
| sortfield | string/array | Ordena el resultado según las propiedades dadas. Valores posibles: mediatypeid. |
| countOutput | boolean | Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en el comentario de referencia. |
| editable | booleano | |
| excluirBuscar | booleano | |
| filtro | objeto | |
| límite | entero | |
| salida | consulta | |
| preservekeys | booleano | |
| buscar | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| clasificación | cadena/matriz | |
| iniciarBuscar | booleano |
Valores de retorno
(entero/matriz) Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el parámetro
countOutputha sido usado.
Ejemplos
Recuperando tipos de medios
Recupere todos los tipos de medios configurados. El siguiente ejemplo devuelve dos tipos de medios:
- tipo de medio de correo electrónico;
- Tipo de medio SMS.
{
"jsonrpc": "2.0",
"método": "mediatype.get",
"parámetros": {
"salida": "extender",
"selectMessageTemplates": "extender"
},
"identificación": 1
}Respuesta:
{
"jsonrpc": "2.0",
"resultado": [
{
"mediatypeid": "1",
"tipo": "0",
"nombre Correo Electronico",
"smtp_server": "correo.ejemplo.com",
"smtp_helo": "ejemplo.com",
"smtp_email": "[email protected]",
"exec_path": "",
"gsm_modem": "",
"nombre de usuario": "",
"contraseña": "",
"estado": "0",
"smtp_port": "25",
"smtp_security": "0",
"smtp_verify_peer": "0",
"smtp_verify_host": "0",
"smtp_authentication": "0",
"maxsesiones": "1",
"maxintentos": "3",
"attempt_interval": "10s",
"message_format": "0",
"guion": "",
"tiempo de espera": "30s",
"etiquetas_proceso": "0",
"show_event_menu": "1",
"event_menu_url": "",
"event_menu_name": "",
"descripción": "",
"plantillas_mensajes": [
{
"fuente de eventos": "0",
"recuperación": "0",
"subject": "Problema: {EVENT.NAME}",
"message": "El problema comenzó a las {EVENT.TIME} el {EVENT.DATE}\r\nNombre del problema: {EVENT.NAME}\r\nHost: {HOST.NAME}\r\nSeveridad: {EVENT.SEVERITY} \r\nDatos operativos: {EVENT.OPDATA}\r\nID del problema original: {EVENT.ID}\r\n{TRIGGER.URL}"
},
{
"fuente de eventos": "0",
"recuperación": "1",
"asunto": "Resuelto: {EVENT.NAME}",
"message": "El problema se resolvió a las {EVENT.RECOVERY.TIME} el {EVENT.RECOVERY.DATE}\r\nNombre del problema: {EVENT.NAME}\r\nHost: {HOST.NAME}\r\nSeveridad : {EVENT.SEVERITY}\r\n\r\nID del problema original: {EVENT.ID}\r\n{TRIGGER.URL}"
},
{
"fuente de eventos": "0",
"recuperación": "2",
"subject": "Problema actualizado: {EVENT.NAME}",
"message": "Problema de {USER.FULLNAME} {EVENT.UPDATE.ACTION} en {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}.\r\n{EVENT.UPDATE.MESSAGE}\r\n\ r\nEl estado del problema actual es {EVENT.STATUS}, confirmado: {EVENT.ACK.STATUS}."
},
{
"fuente de eventos": "1",
"recuperación": "0",
"subject": "Descubrimiento: {DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}",
"message": "Regla de descubrimiento: {DISCOVERY.RULE.NAME}\r\n\r\nIP del dispositivo: {DISCOVERY.DEVICE.IPADDRESS}\r\nDNS del dispositivo: {DISCOVERY.DEVICE.DNS}\r\nEstado del dispositivo : {DISCOVERY.DEVICE.STATUS}\r\nTiempo de actividad del dispositivo: {DISCOVERY.DEVICE.UPTIME}\r\n\r\nNombre del servicio del dispositivo: {DISCOVERY.SERVICE.NAME}\r\nPuerto del servicio del dispositivo: {DISCOVERY.SERVICE .PORT}\r\nEstado del servicio del dispositivo: {DISCOVERY.SERVICE.STATUS}\r\nTiempo de actividad del servicio del dispositivo: {DISCOVERY.SERVICE.UPTIME}"
},
{
"fuente de eventos": "2",
"recuperación": "0",
"subject": "Registro automático: {HOST.HOST}",
"message": "Nombre de host: {HOST.HOST}\r\nIP de host: {HOST.IP}\r\nPuerto de agente: {HOST.PORT}"
}
],
"parámetros": []
},
{
"mediatypeid": "3",
"tipo 2",
"nombre": "SMS",
"servidor SMTP": "",
"smtp_helo": "",
"smtp_email": "",
"exec_path": "",
"gsm_modem": "/dev/ttyS0",
"nombre de usuario": "",
"contraseña": "",
"estado": "0",
"smtp_port": "25",
"smtp_security": "0",
"smtp_verify_peer": "0",
"smtp_verify_host": "0",
"smtp_authentication": "0",
"maxsesiones": "1",
"maxintentos": "3",
"attempt_interval": "10s",
"message_format": "1",
"guion": "",
"tiempo de espera": "30s",
"etiquetas_proceso": "0",
"show_event_menu": "1",
"event_menu_url": "",
"event_menu_name": "",
"descripción": "",
"plantillas_mensajes": [
{
"fuente de eventos": "0",
"recuperación": "0",
"sujeto": "",
"mensaje": "{EVENT.SEVERITY}: {EVENT.NAME}\r\nHost: {HOST.NAME}\r\n{EVENT.DATE} {EVENT.TIME}"
},
{
"fuente de eventos": "0",
"recuperación": "1",
"sujeto": "",
"message": "RESUELTO: {EVENT.NAME}\r\nHost: {HOST.NAME}\r\n{EVENT.DATE} {EVENT.TIME}"
},
{
"fuente de eventos": "0",
"recuperación": "2",
"sujeto": "",
"message": "Problema de {USER.FULLNAME} {EVENT.UPDATE.ACTION} en {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}"
},
{
"fuente de eventos": "1",
"recuperación": "0",
"sujeto": "",
"mensaje": "Descubrimiento: {DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}"
},
{
"fuente de eventos": "2",
"recuperación": "0",
"sujeto": "",
"message": "Registro automático: {HOST.HOST}\r\nIP del host: {HOST.IP}\r\nPuerto del agente: {HOST.PORT}"
}
],
"parámetros": []
}
],
"identificación": 1
}Recuperar tipos de medios de script y webhook
El siguiente ejemplo devuelve tres tipos de medios:
- tipo de medio script con parámetros;
- tipo de medio script sin parámetros;
- tipo de medio de webhook con parámetros.
{
"jsonrpc": "2.0",
"method": "mediatype.get",
"params": {
"output": ["mediatypeid", "name", "parameters"],
"filter": {
"type": [1, 4]
}
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"mediatypeid": "10",
"name": "Script with parameters",
"parameters": [
{
"sortorder": "0",
"value": "{ALERT.SENDTO}"
},
{
"sortorder": "1",
"value": "{EVENT.NAME}"
},
{
"sortorder": "2",
"value": "{ALERT.MESSAGE}"
},
{
"sortorder": "3",
"value": "Zabbix alert"
}
]
},
{
"mediatypeid": "13",
"name": "Script without parameters",
"parameters": []
},
{
"mediatypeid": "11",
"name": "Webhook",
"parameters": [
{
"name": "alert_message",
"value": "{ALERT.MESSAGE}"
},
{
"name": "event_update_message",
"value": "{EVENT.UPDATE.MESSAGE}"
},
{
"name": "host_name",
"value": "{HOST.NAME}"
},
{
"name": "trigger_description",
"value": "{TRIGGER.DESCRIPTION}"
},
{
"name": "trigger_id",
"value": "{TRIGGER.ID}"
},
{
"name": "alert_source",
"value": "Zabbix"
}
]
}
],
"id": 1
}Ver también
Fuente
CMediaType::get() en ui/include/classes/api/services/CMediaType.php.