/ /

Configuraciones de Alerta

Docs Home

/ /

Mediciones y alertas

Configuraciones de Alerta

Configuraciones de Alerta

Habilitar/deshabilitar la configuración de alertas

Cloud Manager dejará de admitir la Automatización, la Copia de seguridad y la Supervisión para MongoDB 3.6 y 4.0 después del 30de agosto de 2024. Por favor actualiza tu implementación de MongoDB o migra a Atlas.

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://cloud.mongodb.com/api/public/v1.0

Resource

PATCH /groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}

Nota

Este endpoint solo actualiza el estado habilitado/deshabilitado de la configuración de alertas. Para actualizar más que solo esta configuración, consulte Actualizar una configuración de alerta.

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.
ALERT-CONFIG-ID	string	Identificador único para esta configuración de alertas.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que señala si el cuerpo de respuesta debe estar en un prettyprint 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 un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuesta HTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Todos los parámetros del cuerpo de la solicitud son obligatorios.

Parameter	Tipo	Descripción
habilitado	booleano	Especifique `true` para habilitar; `false` para deshabilitar.

Respuesta

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 Cloud Manager aplicó al verificar el valor métrico actual en comparación con 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 destinos para que Cloud Manager envíe notificaciones cuando se detecte una condición de alerta.
notifications.[n] .apiToken	string	token del token de API de Slack. Cloud Manager devuelve este valor si 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. Cloud Manager devuelve este valor si establece `notifications.[n].typeName` en `SLACK`.
notifications.[n] .datadogApiKey	string	Clave API de DataDog. Cloud Manager devuelve este valor si se configura `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. Cloud Manager devuelve este valor si establece `notifications.[n].typeName` en `EMAIL`.
notifications.[n] .emailEnabled	booleano	Bandera que indica que se deben enviar notificaciones por correo electrónico. Cloud Manager devuelve este valor si configuras `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. Cloud Manager devuelve este valor si 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. Cloud Manager devuelve este valor si establece `notifications.[n].typeName` en `SMS`.
notifications.[n] .notificationToken	string	Token de la API de HipChat. Cloud Manager devuelve este valor si establece `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. Cloud Manager devuelve este valor si usted ajusta `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 la URL de la API que se usará. Cloud Manager devuelve este valor si se configura `notifications.[n].typeName` de `OPS_GENIE` a.
notifications.[n] .roles	Arreglo de cadenas	Rol de Cloud Manager en el proyecto u organización actual. Cloud Manager devuelve este valor si se establece `notifications.[n].typeName` en `ORG` o `GROUP`.
notifications.[n] .roomName	string	Nombre del cuarto de HipChat. Cloud Manager devuelve este valor si `"notifications.typeName" : "HIP_CHAT`.
notifications.[n] .serviceKey	string	Clave de servicio PagerDuty. Cloud 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: 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	Indicador que señala que se deben enviar notificaciones de texto. Cloud 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 Cloud Manager le envíe notificaciones de una alerta.
notifications.[n] .username	string	Nombre de un usuario de Cloud Manager al que se enviarán notificaciones. Cloud Manager devuelve este valor si se establece `notifications.[n].typeName` en `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. Cloud Manager devuelve este valor si configura `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. Cloud Manager devuelve este valor si configura `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] .webhookSecret	string	Un valor utilizado para autenticar con el Webhook que acepta y reenvía la notificación. Cloud Manager devuelve este valor si estableces `notifications.[n].typeName` en `WEBHOOK` y se da alguna de las siguientes condiciones: 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. Cloud Manager devuelve este valor si estableces `notifications.[n].typeName` en `WEBHOOK` y se da alguna de las siguientes condiciones: 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.
límite	Objeto	Umbral que activa una alerta. Cloud Manager devuelve este valor si `eventTypeName` es cualquier valor distinto de `OUTSIDE_METRIC_THRESHOLD`.
threshold .operator	string	Operador de comparación que Cloud Manager aplicó al verificar el valor métrico actual en comparación con el valor umbral.
threshold .threshold	Número	Valor que al ser superado Cloud Manager dispara 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 'Content-Type: application/json' \
     --include \
     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}" \
     --data '
       {
         "enabled" : false
       }'

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

{
  "created" : "2014-04-23T14:52:29Z",
  "enabled" : false,
  "groupId" : "{PROJECT-ID}",
  "id" : "{ALERT-CONFIG-ID}",
  "links" : [],
  "matchers" : [ {
    "fieldName" : "REPLICA_SET_NAME",
    "operator" : "EQUALS",
    "value" : "rs1"
  } ],
  "notifications" : [ {
    "delayMin" : 5,
    "emailAddress" : "sos@example.com",
    "intervalMin" : 60,
    "typeName" : "EMAIL"
  }, {
    "delayMin" : 60,
    "emailEnabled" : false,
    "intervalMin" : 120,
    "smsEnabled" : true,
    "typeName" : "GROUP"
  } ],
  "updated" : "2014-04-23T14:52:29Z"
}

Volver

Update

Borrar