/ /

Mediciones y alertas

Configuraciones de Alerta

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Mediciones y alertas

Configuraciones de Alerta

Obtener todas las configuraciones de alerta para un proyecto

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es el mismo que tu id. de proyecto. Para los grupos existentes, su ID de grupo/ID del grupo seguirá siendo el mismo. Esta página utiliza el término más familiar grupo al referirse a descripciones. El endpoint se mantiene tal 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 ruta de solicitud son obligatorios.

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

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
Num. de pág.	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
elementosPorPágina	Número	Opcional	Número de elementos a devolver por página, hasta un máximo de 500.	`100`
bonito	booleano	Opcional	Bandera que indica si el cuerpo de la respuesta debe estar en una pretty-print formato.	`false`
envelope	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 endpoints que devuelven una lista de resultados, el objeto `content` es un sobre. Ops Manager agrega el campo `status` al cuerpo de la respuesta.	`false`

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de 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` Documento incrustado.
`links`	arreglo	El arreglo incluye uno o más enlaces a subrecursos y/o recursos relacionados. Las relaciones entre URLse explican en la Especificación de enlace web.
`totalCount`	Número	Recuento entero del número total de elementos en el conjunto de resultados. Puede ser superior al número de objetos en el arreglo results si el conjunto de resultados completo está paginado.

`results` embeddedDocument

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	Indicador de que esta configuración de alerta está habilitada.
nombreDeTipoDeEvento	string	Tipo de evento que activa una alerta.
ID del 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	Arreglo 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	Arreglo 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 que deseas que esta configuración coincida.
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`.
metricThreshold	Objeto	Valor y medio de comparación que activa una alerta.
metricThreshold .metricName	string	Nombre de la métrica 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, desencadena una alerta.
metricThreshold .units	string	Unidades de capacidad o tiempo que definen el alcance del `metricThreshold.threshold`.
notificaciones	Arreglo 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: Visualiza o edita 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 estableces `notifications.[n].typeName` a `SLACK`.
notifications.[n] .datadogApiKey	string	Clave de API de DataDog. Ops Manager devuelve este valor si estableces `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: Visualiza o edita 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 de espera tras detectarse 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 enviar la notificación. Ops Manager devuelve este valor si estableces `notifications.[n].typeName` en `EMAIL`.
notifications.[n] .emailEnabled	booleano	Bandera que indica que se deben enviar notificaciones por correo electrónico. Ops Manager devuelve este valor si estableces `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 del webhook entrante del canal de Microsoft Teams. Ops Manager devuelve este valor si estableces `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 estableces `notifications.[n].typeName` en `SMS`.
notifications.[n] .notificationToken	string	Token de la API de HipChat. Ops Manager devuelve este valor si estableces `notifications.[n].typeName` en `HIP_CHAT`. Si el token se vuelve inválido más adelante, MongoDB Atlas enviará un correo electrónico a `Project Owner` y eventualmente removerá 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: Visualiza o edita 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	API de alertas de OpsGenie clave. Ops Manager devuelve este valor si se establece `notifications.[n].typeName` en `OPS_GENIE`. 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: Visualiza o edita 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 qué API URL utilizar. Ops Manager devuelve este valor si se establece `notifications.[n].typeName` en `OPS_GENIE`.
notifications.[n] .roles	Arreglo 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 de HipChat. Ops Manager devuelve este valor si `"notifications.typeName" : "HIP_CHAT`.
notifications.[n] .serviceKey	string	Clave de servicio de PagerDuty. Ops Manager devuelve este valor si estableces `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: Visualiza o edita 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] .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	Medios por los cuales 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	VictorOps API key. 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 estableces `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: Visualiza o edita 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 estableces `notifications.[n].typeName` en `VICTOR_OPS`.
notifications.[n] .webhookSecret	string	Un valor utilizado para autenticar con el Webhook que acepta y reenvía la notificación. Ops Manager devuelve este valor si establece `notifications.[n].typeName` en `WEBHOOK` y: Se configuró `notification.[n].webhookSecret` como una string 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 está parcialmente redactada cuando ves o editas la alerta, y el secreto está completamente redactado.
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: Se configuró `notification.[n].webhookURL` como una string 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 está parcialmente redactada cuando ves o editas la alerta, y el secreto está completamente redactado.
notifications.[n] .webhookHeadersTemplate	string	Plantilla para encabezados personalizados que se incluyen en las notificaciones de webhook. Ops Manager devuelve este valor si se establece `notifications.[n].typeName` en `WEBHOOK` y se proporciona una plantilla de encabezados personalizados.
notifications.[n] .webhookBodyTemplate	string	Plantilla para el contenido del cuerpo de las notificaciones de webhook. El Administrador de operaciones devuelve este valor si se establece `notifications.[n].typeName` en `WEBHOOK` y se proporciona una plantilla personalizada.
notifications.[n] .id	string	Identificador único de la configuración de notificación.
límite	Objeto	Umbral que activa una alerta. Ops Manager devuelve este valor si `eventTypeName` es algún 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 excede, Ops Manager activa una alerta.
threshold .units	string	Unidades de capacidad o tiempo que definen el alcance del `threshold.threshold`.
typeName	string	Este campo está obsoleto y se ignora.
actualizado	string	Marca de tiempo en ISO 8601 formato de fecha y hora en UTC cuando esta configuración de alerta se actualizó por última vez.

Solicitud de ejemplo

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"

Respuesta de ejemplo

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}

Respuesta del cuerpo

{
  "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 Solicitud Query

Parámetros del cuerpo de la solicitud

Respuesta

Documento de respuesta

results embeddedDocument

Nota

Solicitud de ejemplo

Respuesta de ejemplo

Encabezado de respuesta

Respuesta del cuerpo

`results` embeddedDocument