Obtener todas las configuraciones de alertas para un proyecto

Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de MongoDB Ops Manager.

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} Es el mismo que el ID de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. Esta página utiliza el término "grupo" para las descripciones. El punto final se mantiene como se indica en el documento.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

GET /groups/{PROJECT-ID}/alertConfigs

Parámetros de la ruta de solicitud

Todos los parámetros de la ruta de solicitud son obligatorios.

Parameter	Tipo	Descripción
PROJECT-ID	string	Identificador único para este proyecto.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
número de página	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
artículos por página	Número	Opcional	Número de artículos a devolver por página, hasta un máximo de 500.	`100`
bonita	booleano	Opcional	Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato.	`false`
envolvente	booleano	Opcional	Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure `envelope : true` en la consulta. Para los puntos finales que devuelven una lista de resultados, el objeto `results` es un sobre. Ops Manager añade el campo `status` al cuerpo de la respuesta.	`false`
trabajos de respaldo habilitados solamente	booleano	Opcional	Indicador que indica si se deben excluir de la respuesta los daemons no habilitados para realizar copias de seguridad de bases de datos. Establezca este valor en `false` para incluir las configuraciones de daemon con el indicador `backupJobsEnabled` establecido en `false`.	`true`

Parámetros del cuerpo de la solicitud

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

Documento de respuesta

El documento JSON de respuesta incluye una matriz de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.

Nombre	Tipo	Descripción
`results`	arreglo	La matriz incluye un objeto para cada elemento detallado en el Sección`results` de documento incrustado.
`links`	arreglo	La matriz incluye uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.
`totalCount`	Número	Número entero del número total de elementos en el conjunto de resultados. Puede ser mayor que el número de objetos en la matriz results si todo el conjunto de resultados está paginado.

`results` Documento incrustado

Cada resultado es una configuración de alerta.

Nota

Las configuraciones de alerta varían. Una configuración de alerta puede incluir solo un subconjunto de estos elementos.

Nombre	Tipo	Descripción
creado	string	Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando se creó esta configuración de alerta.
habilitado	booleano	Bandera que indica que esta configuración de alerta está habilitada.
nombreDeTipoDeEvento	string	Tipo de evento que activa una alerta.
ID de grupo	string	Identificador único del Proyecto propietario de esta configuración de alerta.
ID.	string	Identificador único de la configuración de la alerta.
enlaces	matriz de objetos	Uno o más enlaces a sub-recursos y/o recursos relacionados. Los tipos de relación entre URLs se explican en la Especificación de Vinculación Web.
comparadores	matriz de objetos	Reglas para aplicar al comparar un objeto con esta configuración de alerta.
matchers .[n].fieldName	string	Nombre del campo en el objeto de destino con el que desea que coincida esta configuración.
matchers .[n].operator	string	Operador de comparación que se aplicará al comparar el valor de la métrica actual con `matcher.[n].value`.
matchers .[n].value	string	Valor a igualar o superar utilizando `matchers.[n].operator`.
Umbral métrico	Objeto	Valor y medio de comparación que dispara una alerta.
metricThreshold .metricName	string	Nombre de la métrica que se va a comprobar. Admite los mismos valores que el campo `metricName` del recurso `alerts`.
metricThreshold .mode	string	Valor promedio de esta métrica.
metricThreshold .operator	string	Operador de comparación que Ops Manager aplicó al verificar el valor métrico actual contra el valor umbral.
metricThreshold .threshold	Número	Valor de `metricThreshold.metricName` que, al superarse, activa una alerta.
metricThreshold .units	string	Unidades de capacidad o tiempo que definen el alcance del `metricThreshold.threshold`.
notificaciones	matriz de objetos	Uno o más objetivos para que Ops Manager envíe notificaciones cuando se detecta una condición de alerta.
notifications.[n] .apiToken	string	Token de la API de Slack. Ops Manager devuelve este valor si se establece `notifications.[n].typeName` en `SLACK`. Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando: Ver o editar la alerta a través de la interfaz de usuario. Consulta la configuración de integración de terceros a través de la API.
notifications.[n] .channelName	string	Nombre del canal de Slack. Ops Manager devuelve este valor si se establece `notifications.[n].typeName` en `SLACK`.
notifications.[n] .datadogApiKey	string	Clave API de DataDog. Ops Manager devuelve este valor si se establece `notifications.[n].typeName` en `DATADOG`. Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando: Ver o editar la alerta a través de la interfaz de usuario. Consulta la configuración de integración de terceros a través de la API.
notifications.[n] .delayMin	Número	Número de minutos a esperar después de que se detecta una condición de alerta antes de enviar la primera notificación.
notifications.[n] .emailAddress	string	Dirección de correo electrónico a la que se enviará la notificación. Ops Manager devuelve este valor si se establece `notifications.[n].typeName` en `EMAIL`.
notifications.[n] .emailEnabled	booleano	Marca que indica que deben enviarse notificaciones por correo electrónico. Ops Manager devuelve este valor si se establece `notifications.[n].typeName` en `ORG`, `GROUP` o `USER`.
notifications.[n] .intervalMin	Número	Número de minutos de espera entre notificaciones sucesivas de alertas no reconocidas que no se resuelven.
notifications.[n] .microsoftTeamsWebhookUrl	string	URL de webhook entrante del canal de Microsoft Teams. Ops Manager devuelve este valor si se establece `notifications.[n].typeName` en `MICROSOFT_TEAMS`. Cuando se ve o edita la alerta de una notificación de webhook, la URL aparece parcialmente oculta y el secreto aparece completamente oculto.
notifications.[n] .mobileNumber	string	Número de teléfono móvil al que se envían las notificaciones de alerta. Ops Manager devuelve este valor si se establece `notifications.[n].typeName` en `SMS`.
notifications.[n] .notificationToken	string	Token de la API de HipChat. Ops Manager devuelve este valor si se establece `notifications.[n].typeName` en `HIP_CHAT`. Si posteriormente el token deja de ser válido, MongoDB Atlas envía un correo electrónico a `Project Owner` y finalmente elimina el token. Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando: Ver o editar la alerta a través de la interfaz de usuario. Consulta la configuración de integración de terceros a través de la API.
notifications.[n] .opsGenieApiKey	string	ClaveAPI de alerta de OpsGenie. Ops Manager devuelve este valor si se `notifications.[n].typeName` configura `OPS_GENIE` en. Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando: Ver o editar la alerta a través de la interfaz de usuario. Consulta la configuración de integración de terceros a través de la API.
notifications.[n] .opsGenieRegion	string	Región que indica la URL de la API que se usará. Ops Manager devuelve este valor si se `notifications.[n].typeName` configuran `OPS_GENIE` a.
notifications.[n] .roles	matriz de cadenas	Rol de administrador de operaciones en el proyecto u organización actual. El administrador de operaciones devuelve este valor si se establece `notifications.[n].typeName` en `ORG` o `GROUP`.
notifications.[n] .roomName	string	Nombre de la sala HipChat. Ops Manager devuelve este valor si `"notifications.typeName" : "HIP_CHAT`.
notifications.[n] .serviceKey	string	Clave de servicio PagerDuty. Ops Manager devuelve este valor si se establece `notifications.[n].typeName` en `PAGER_DUTY`. Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando: Ver o editar la alerta a través de la interfaz de usuario. Consulta la configuración de integración de terceros a través de la API.
notifications.[n] .smsEnabled	booleano	Bandera que indica que deben enviarse notificaciones de texto. Ops Manager devuelve este valor si se establece `notifications.[n].typeName` en `ORG`, `GROUP` o `USER`.
notifications.[n] .snmpAddress	string	Nombre de host y puerto al que se envían las traps SNMP. Actualmente, Ops Manager solo puede enviar traps SNMP al puerto SNMP estándar 162 (). Se completa para `SNMP` las notificaciones. Ops Manager usa SNMP v2c. Importante Ops Manager 6.0.0 deja de usar las alertas SNMP. Ops Manager 7.0.0 no las incluirá. Para obtener más información sobre otras opciones de alerta, consulte Integraciones de servicios de terceros.
notifications.[n] .teamId	string	Identificador único del equipo que recibe esta notificación.
notifications.[n] .teamName	string	Etiqueta para el equipo que recibe esta notificación.
notifications.[n] .typeName	string	Medio por el cual desea que Ops Manager le envíe una notificación de una alerta.
notifications.[n] .username	string	Nombre de un usuario de Ops Manager al que se enviarán notificaciones. Ops Manager devuelve este valor si se establece de `notifications.[n].typeName` a `USER`.
notifications.[n] .victorOpsApiKey	string	Clave API de VictorOps. Si posteriormente la clave deja de ser válida, MongoDB Atlas envía un correo electrónico a y finalmente elimina la `Project Owner` clave. Ops Manager devuelve este valor si establece `notifications.[n].typeName` en `VICTOR_OPS`. Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando: Ver o editar la alerta a través de la interfaz de usuario. Consulta la configuración de integración de terceros a través de la API.
notifications.[n] .victorOpsRoutingKey	string	Clave de enrutamiento de VictorOps. Si posteriormente la clave deja de ser válida, MongoDB Atlas envía un correo electrónico a y finalmente elimina la `Project Owner` clave. Ops Manager devuelve este valor si establece `notifications.[n].typeName` en `VICTOR_OPS`.
notifications.[n] .webhookSecret	string	Un valor utilizado para autenticarse con el webhook que acepta y reenvía la notificación. Ops Manager devuelve este valor si establece `notifications.[n].typeName` en `WEBHOOK` y: Establece `notification.[n].webhookSecret` en una cadena no vacía Establece un valor predeterminado `webhookSecret` en la página Integracioneso con la API de Integraciones Después de crear una notificación de webhook, la URL se redacta parcialmente cuando usted ve o edita la alerta, y el secreto se redacta por completo.
notifications.[n] .webhookUrl	string	URL del webhook que activa esta notificación. Ops Manager devuelve este valor si establece `notifications.[n].typeName` en `WEBHOOK` y: Establece `notification.[n].webhookURL` en una cadena no vacía Establece un valor predeterminado `webhookUrl` en la página Integracioneso con la API de Integraciones Después de crear una notificación de webhook, la URL se redacta parcialmente cuando usted ve o edita la alerta, y el secreto se redacta por completo.
límite	Objeto	Umbral que activa una alerta. Ops Manager devuelve este valor si `eventTypeName` es cualquier valor distinto de `OUTSIDE_METRIC_THRESHOLD`.
threshold .operator	string	Operador de comparación que Ops Manager aplicó al verificar el valor métrico actual contra el valor umbral.
threshold .threshold	Número	Valor que, cuando se supera, Ops Manager activa una alerta.
threshold .units	string	Unidades de capacidad o tiempo que definen el alcance del `threshold.threshold`.
tipoNombre	string	Este campo está obsoleto y se ignora.
actualizado	string	Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando se actualizó por última vez esta configuración de alerta.

Ejemplo de solicitud

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs"

Ejemplo de respuesta

Encabezado de respuesta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Cuerpo de respuesta

{
  "links" : [],
  "results": [ {
    "created" : "2013-10-30T15:28:30Z",
    "enabled" : true,
    "eventTypeName" : "RESYNC_REQUIRED",
    "groupId" : "{PROJECT-ID}",
    "id" : "5271259ee4b00ece6b4754ef",
    "links" : [],
    "matchers" : [ ],
    "notifications" : [ {
      "delayMin" : 0,
      "emailAddress" : "somebody@example.com",
      "intervalMin" : 60,
      "typeName" : "EMAIL"
    } ],
    "updated" : "2014-02-12T16:11:05Z"
  }, {
    "created" : "2014-03-19T16:42:07Z",
    "enabled" : true,
    "eventTypeName" : "MONITORING_AGENT_DOWN",
    "groupId" : "{PROJECT-ID}",
    "id" : "5329c8dfe4b0b07a83d67e7e",
    "links" : [],
    "matchers" : [ ],
    "notifications" : [ {
      "delayMin" : 0,
      "emailEnabled" : true,
      "intervalMin" : 5,
      "smsEnabled" : false,
      "typeName" : "GROUP"
    } ],
    "updated" : "2014-03-19T16:42:07Z"
  }, {
    "created" : "2014-04-03T20:26:50Z",
    "enabled" : true,
    "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
    "groupId" : "{PROJECT-ID}",
    "id" : "533dc40ae4b00835ff81eaee",
    "links" : [],
    "matchers" : [ {
      "field" : "hostnameAndPort",
      "operator" : "EQUALS",
      "value" : "mongo.example.com:27017"
    } ],
    "notifications" : [ {
      "delayMin" : 0,
      "intervalMin" : 5,
      "mobileNumber" : "2343454567",
      "typeName" : "SMS"
    } ],
    "metricThreshold" : {
      "metricName" : "ASSERT_REGULAR",
      "mode" : "AVERAGE",
      "operator" : "LESS_THAN",
      "threshold" : 99.0,
      "units" : "RAW"
    },
    "updated" : "2014-04-03T20:26:50Z",
  } ],
  "totalCount": 3
}

Volver

Obtener nombres de campos de comparadores

Crear

Nota

Resource

Parámetros de la ruta de solicitud

Parámetros de consulta de solicitud

Parámetros del cuerpo de la solicitud

Respuesta

Documento de respuesta

results Documento incrustado

Nota

Importante

Ejemplo de solicitud

Ejemplo de respuesta

Encabezado de respuesta

Cuerpo de respuesta

`results` Documento incrustado