URL de solicitud
OBTENER
https://api.dotcom-monitor.com/config_api_v1/dispositivo {device_id} /
Obtenga la configuración del dispositivo por su id.
Parámetros de ruta
Campo | Tipo | Obligatorio | Descripción |
---|---|---|---|
device_id |
Cadena |
true |
Identificador único de un dispositivo de supervisión. Para solicitar una lista de los ID de los dispositivos dentro de una plataforma, consulte API: Obtener lista de dispositivos por plataforma. |
Respuesta de éxito
Descripción de los campos
Utilice estos campos para especificar información sobre un dispositivo en sus solicitudes de API.
Campo |
Tipo |
Descripción | ||
Avoid_Simultaneous_Checks |
booleano |
Indica si se permite la comprobación simultánea desde varias ubicaciones de supervisión. Disponible solo para dispositivos ServerView.
Ejemplo:
|
||
Alert_Silence_Min |
int32 |
SOLO LECTURA. Define el período de tiempo en minutos cuando todas las alertas están deshabilitadas. Para deshabilitar las alertas, use API: Deshabilitar alertas para dispositivos o API: Deshabilitar alertas para varios dispositivos.
Ejemplo:
|
||
False_Positive_Check |
booleano |
Cuando se detecta el error, ejecutamos series de comprobaciones para asegurarnos de que no es una alerta falsa. Esas comprobaciones pueden tardar algún tiempo, dependiendo del tipo de error y el número de tareas en el dispositivo. Esto puede causar algún retraso en la alerta de tiempo de inactividad. Puede deshabilitar la comprobación de falsopositivo («verdadero» del estado) para garantizar una alerta de tiempo de inactividad inmediata, pero puede dar lugar a algunas alertas «falsas». Recomendamos NO desactivar «Verificación de falsos positivos».
Ejemplo:
|
||
Localizaciones |
matriz de int32 |
Matriz que contiene identificadores de ubicación asignados a un dispositivo especificado. Se debe especificar al menos una ubicación en las solicitudes.
Ejemplo:
|
||
Etiquetas |
matriz de cadena |
Matriz que contiene los nombres de las etiquetas asignadas a un dispositivo especificado.
Ejemplo:
|
||
Send_Uptime_Alert |
booleano |
Cuando esta opción está habilitada, recibirá una alerta cuando se resuelvan todos los errores detectados.
Ejemplo:
|
||
Status_Description |
Cadena |
SOLO LECTURA. Describir el estado actual del dispositivo.
Ejemplo:
|
||
Posponer |
booleano |
La supervisión se puede configurar en una pausa posponiendo un dispositivo.
Ejemplo:
|
||
Owner_Device_Id |
int32 |
Este campo refleja el ID de dispositivo del propietario.
Ejemplo:
|
||
Frecuencia |
int32 |
Este campo refleja la frecuencia de monitoreo en segundos.
Ejemplo:
|
||
Filter_Id |
int32 |
Este campo refleja el ID de filtro asignado a un dispositivo.
Ejemplo:
|
||
Scheduler_Id |
int32 |
Este campo refleja el ID del programador asignado a un dispositivo.
Ejemplo:
|
||
Notificaciones |
matriz de objetos |
Indica la lista de ajustes de alertas
Ejemplo #1:
Ejemplo #2:
|
||
E_Mail_Flag |
booleano |
Define si se enviará la alerta de correo electrónico.
Ejemplo:
|
||
E_Mail_Address |
Cadena |
Especifica una dirección de correo electrónico para las alertas por correo electrónico.
Ejemplo:
|
||
E_Mail_TimeInterval_Min |
int32 |
Este campo permite establecer un intervalo entre las alertas de correo electrónico en minutos
Ejemplo:
|
||
WL_Device_Flag |
booleano |
Define si se enviará la alerta del dispositivo inalámbrico.
Ejemplo:
|
||
WL_Device_Email_Address |
Cadena |
Este campo especifica un dispositivo inalámbrico, como el teléfono o el buscapersonas, para las alertas.
Ejemplo:
|
||
WL_Device_TimeInterval_Min |
int32 |
Este campo permite establecer un intervalo entre las alertas de dispositivos inalámbricos en minutos.
Ejemplo:
|
||
Pager_Flag |
booleano |
Define si se enviarán alertas de buscapersonas.
Ejemplo:
|
||
Pager_Area_Code |
Cadena |
Código de área del buscapersona.
Ejemplo:
|
||
Pager_Phone |
Cadena |
Teléfono buscapersona.
Ejemplo:
|
||
Pager_Num_Code |
Cadena |
Código para un buscapersonas numérico.
Ejemplo:
|
||
Pager_TimeInterval_Min |
int32 |
Este campo permite establecer un intervalo entre las alertas del localizador en minutos.
Ejemplo:
|
||
Phone_Flag |
booleano |
Define si se llevarán a cabo alertas de llamadas telefónicas. Para recibir alertas a través del valor establecido por el teléfono en «true» y especifique el número de teléfono. Las alertas telefónicas son interactivas, lo que le permite posponer las alertas posteriores una vez recibida una alerta.
Ejemplo:
|
||
Phone_Area_Code |
Cadena |
Si el código de país es «1» (por ejemplo, en EE. UU., Canadá y Caribe), escriba el código de área y el número (por ejemplo, 952-5134349). Para todos los demás códigos de país, utilice el prefijo «011», el código de país y el número de teléfono (por ejemplo, 011-44-95-2244392).
Ejemplo:
|
||
Phone_Phone |
Cadena |
Número de teléfono.
Ejemplo:
|
||
Phone_TimeInterval_Min |
int32 |
Este campo permite establecer un intervalo entre llamadas telefónicas.
Ejemplo:
|
||
SMS_Flag |
booleano |
Define si se enviarán alertas SMS.
Ejemplo:
|
||
SMS_Phone |
Cadena | Un número de teléfono con un código de país (por ejemplo: US – 1 952 513 4349; Reino Unido 449524 4392). NO utilice un prefijo de marcación internacional, como «011» en el número.
Ejemplo:
|
||
SMS_TimeInterval_Min |
int32 |
Este campo permite establecer un intervalo entre alertas POR SMS.
Ejemplo:
|
||
Script_Flag |
booleano |
Este campo define si las alertas se realizarán mediante scripts de alerta personalizados.
Ejemplo:
|
||
Script_Batch_File_Name |
Cadena |
Nombre de archivo de script personalizado. Script Tiene que estar ya instalado en el servidor.
Ejemplo:
|
||
Script_TimeInterval_Min |
int32 |
Este campo permite establecer un intervalo entre alertas de script personalizadas.
Ejemplo:
|
||
Notification_Groups |
matriz de objetos |
Indica los grupos de alertas activos con su ID y su turno de tiempo. El cambio de hora es una opción que le permite crear un proceso de escalamiento de alertas que se basa en la duración de la condición de error, por ejemplo, el primer grupo de notificaciones podría ser notificado inmediatamente, segundo después de 10 minutos de tiempo de inactividad y tercer grupo después de 60 minutos de tiempo de inactividad. Los intervalos de tiempo de escalación de alertas varían de inmediato a tres horas.
Ejemplo:
|
||
Number_Of_Tasks |
int32 |
LEER SOLAMENTE Campo. Muestra el número de tareas en el dispositivo especificado.
Ejemplo:
|
||
int32 |
LEER SOLAMENTE Campo. El identificador de dispositivo único. Asignado automáticamente tras la creación de un nuevo dispositivo. Se usa para especificar un dispositivo en las solicitudes.
Ejemplo:
|
|||
Platform_Id |
int32 |
LEER SOLAMENTE Campo. Cada plataforma (ServerView, UserView, etc.) tiene su propio ID. Vea cómo obtener los IDs de las plataformas aquí.
Ejemplo:
|
||
Nombre |
Cadena |
Nombre del dispositivo.
Ejemplo:
|