/ /

Mediciones y alertas

Configuraciones de alertas

Docs Home

MongoDB Ops Manager

API

Recursos

Mediciones y alertas

Configuraciones de alertas

Actualizar una configuración de alerta

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

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

Nota

Para actualizar solo el estado habilitado/deshabilitado para la configuración de alerta, consulte Habilitar/deshabilitar la configuración de alertas en su lugar.

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

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

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 un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
Estado	Código de respuestaHTTP
envolvente	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Nota

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

Nombre	Tipo	Descripción
habilitado	booleano	Si se omite, la configuración se deshabilita.
eventTypeName Required.	string	El tipo de evento que activa una alerta. Los valores incluyen: Agente `AUTOMATION_AGENT_DOWN` `AUTOMATION_AGENT_UP` `BACKUP_AGENT_CONF_CALL_FAILURE` `BACKUP_AGENT_DOWN` `BACKUP_AGENT_UP` `BACKUP_AGENT_VERSION_BEHIND` `BACKUP_AGENT_VERSION_CURRENT` `MONITORING_AGENT_DOWN` `MONITORING_AGENT_UP` `MONITORING_AGENT_VERSION_BEHIND` `MONITORING_AGENT_VERSION_CURRENT` `NEW_AGENT` Configuración de automatización `AUTOMATION_CONFIG_PUBLISHED_AUDIT` Backup `BAD_CLUSTERSHOTS` `CLUSTER_BLACKLIST_UPDATED_AUDIT` `CLUSTER_CHECKKPOINT_UPDATED_AUDIT` `CLUSTER_CREDENTIAL_UPDATED_AUDIT` `CLUSTER_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` `CLUSTER_STATE_CHANGED_AUDIT` `CLUSTER_STORAGE_ENGINE_UPDATED_AUDIT` `CLUSTERSHOT_DELETED_AUDIT` `CLUSTERSHOT_EXPIRY_UPDATED_AUDIT` `CONSISTENT_BACKUP_CONFIGURATION` `GOOD_CLUSTERSHOT` `INCONSISTENT_BACKUP_CONFIGURATION` `INITIAL_SYNC_FINISHED_AUDIT` `INITIAL_SYNC_STARTED_AUDIT` `OPLOG_BEHIND` `OPLOG_CURRENT` `RESTORE_REQUESTED_AUDIT` `RESYNC_PERFORMED` `RESYNC_REQUIRED` `RS_BLACKLIST_UPDATED_AUDIT` `RS_CREDENTIAL_UPDATED_AUDIT` `RS_ROTATE_MASTER_KEY_AUDIT` `RS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` `RS_STATE_CHANGED_AUDIT` `RS_STORAGE_ENGINE_UPDATED_AUDIT` `SNAPSHOT_DELETED_AUDIT` `SNAPSHOT_EXPIRY_UPDATED_AUDIT` `SYNC_PENDING_AUDIT` `SYNC_REQUIRED_AUDIT` Conector de BI `BI_CONNECTOR_DOWN` `BI_CONNECTOR_UP` Clúster `CLUSTER_MONGOS_IS_MISSING` `CLUSTER_MONGOS_IS_PRESENT` `SHARD_ADDED` `SHARD_REMOVED` Explorador de datos accedido `DATA_EXPLORER` `DATA_EXPLORER_CRUD` Host `ADD_HOST_AUDIT` `ADD_HOST_TO_REPLICA_SET_AUDIT` `DELETE_HOST_AUDIT` `HOST_DOWN` `HOST_RECOVERING` `HOST_RESTARTED` `HOST_ROLLBACK` `HOST_SSL_CERTIFICATE_STALE` `OUTSIDE_METRIC_THRESHOLD` `REMOVE_HOST_FROM_REPLICA_SET_AUDIT` `UNDELETE_HOST_AUDIT` `VERSION_BEHIND` Organización `ALL_ORG_USERS_HAVE_MFA` `ORG_API_KEY_ADDED` `ORG_API_KEY_DELETED` `ORG_EMPLOYEE_ACCESS_RESTRICTED` `ORG_EMPLOYEE_ACCESS_UNRESTRICTED` `ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED` `ORG_PUBLIC_API_ACCESS_LIST_REQUIRED` `ORG_RENAMED` `ORG_TWO_FACTOR_AUTH_OPTIONAL` `ORG_TWO_FACTOR_AUTH_REQUIRED` `ORG_USERS_WITHOUT_MFA` Proyecto `ALL_USERS_HAVE_MULTI_FACTOR_AUTH` `USERS_WITHOUT_MULTI_FACTOR_AUTH` Set de réplicas `CONFIGURATION_CHANGED` `ENOUGH_HEALTHY_MEMBERS` `MEMBER_ADDED` `MEMBER_REMOVED` `MULTIPLE_PRIMARIES` `NO_PRIMARY` `ONE_PRIMARY` `PRIMARY_ELECTED` `TOO_FEW_HEALTHY_MEMBERS` `TOO_MANY_ELECTIONS` `TOO_MANY_UNHEALTHY_MEMBERS` Equipo `TEAM_ADDED_TO_GROUP` `TEAM_CREATED` `TEAM_DELETED` `TEAM_NAME_CHANGED` `TEAM_REMOVED_FROM_GROUP` `TEAM_ROLES_MODIFIED` `TEAM_UPDATED` `USER_ADDED_TO_TEAM` Usuario `INVITED_TO_GROUP` `INVITED_TO_ORG` `JOIN_GROUP_REQUEST_APPROVED_AUDIT` `JOIN_GROUP_REQUEST_DENIED_AUDIT` `JOINED_GROUP` `JOINED_ORG` `JOINED_TEAM` `REMOVED_FROM_GROUP` `REMOVED_FROM_ORG` `REMOVED_FROM_TEAM` `REQUESTED_TO_JOIN_GROUP` `USER_ROLES_CHANGED_AUDIT` Para consultar la lista completa de eventos que generan alertas y sus descripciones, consulte Tipos de alerta. Para obtener una lista completa de los eventos incluidos en el registro de auditoría de Ops Manager, consulte Eventos de auditoría.
matchers.nombreDeCampo	string	Nombre del campo en el objeto de destino que va a coincidir. Las alertas de host admiten estos campos: `HOSTNAME` `PORT` `HOSTNAME_AND_PORT` `REPLICA_SET_NAME` `TYPE_NAME` Las alertas del conjunto de réplicas admiten estos campos: `REPLICA_SET_NAME` `SHARD_NAME` `CLUSTER_NAME` Las alertas de clúster fragmentado admiten estos campos: `CLUSTER_NAME` `SHARD_NAME` Todos los demás tipos de alertas no admiten comparadores.
operadores de coincidencias	string	Operador para comprobar el valor del campo. Los valores aceptados son: `EQUALS` `NOT_EQUALS` `CONTAINS` `NOT_CONTAINS` `STARTS_WITH` `ENDS_WITH` `REGEX`
comparadores.valor	string	Valor a probar con el operador especificado. Si `matchers.fieldName` se establece en `TYPE_NAME`, puede coincidir con los siguientes valores: `PRIMARY` `SECONDARY` `STANDALONE` `CONFIG` `MONGOS`
comparadores	matriz de objetos	Reglas que se aplican al comparar un objeto con esta configuración de alerta. Solo las entidades que cumplen todas estas reglas se verifican para detectar una condición de alerta. Puede filtrar utilizando la matriz `matchers` solo cuando `eventTypeName` especifica un evento para un host, un conjunto de réplicas o un clúster fragmentado.
metricThreshold.metricName	string	Nombre de la métrica que se va a comprobar. Admite los mismos valores que el campo `metricName` del recurso `alerts`.
modo de umbral métrico	string	Establezca en `AVERAGE` para calcular el promedio de esta métrica.
operadorUmbralMétrico	string	Operador que se aplica al comparar el valor de la métrica actual con el valor umbral. Los valores aceptados son: `GREATER_THAN` `LESS_THAN`
Umbralmétrico.umbral	Número	Valor de umbral fuera del cual se activa una alerta.
Umbral métrico.unidades	string	Unidades para el valor umbral. Depende del tipo de métrica. Ejemplo Una métrica que mide el consumo de memoria tendría una medida de byte, mientras que una métrica que mide el tiempo tendría una unidad de tiempo. Los valores aceptados son: `RAW` `BITS` `BYTES` `KILOBITS` `KILOBYTES` `MEGABITS` `MEGABYTES` `GIGABITS` `GIGABYTES` `TERABYTES` `PETABYTES` `MILLISECONDS` `SECONDS` `MINUTES` `HOURS` `DAYS`
Umbral métrico	Objeto	Umbral que activará una alerta. Obligatorio si `"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"`.
notificaciones.apiToken	string	Token de API de Slack o token de bot. Obligatorio si `"notifications.typeName" : "SLACK"`. Si el token deja de ser válido posteriormente, Ops Manager envía un correo electrónico al propietario del proyecto y, finalmente, lo elimina. 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.
notificaciones.nombredelcanal	string	Nombre del canal de Slack. Obligatorio si `"notifications.typeName" : "SLACK"`.
notificaciones.datadogApiKey	string	Clave API de DataDog. Disponible en el panel de control de DataDog. Requerida si `"notifications.typeName" : "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.
notificaciones.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.
notificaciones.dirección de correo electrónico	string	Dirección de correo electrónico para enviar notificaciones. Obligatorio si `"notifications.typeName" : "EMAIL"`.
notificaciones.emailEnabled	booleano	Determina si se deben enviar notificaciones por correo electrónico. Obligatorio si: `"notifications.typeName" : "GROUP"` `"notifications.typeName" : "USER"`
notificaciones.intervalMin	Número	Número de minutos de espera entre notificaciones sucesivas de alertas no reconocidas que no se resuelven.
notificaciones.webhookSecret	string	Un valor usado para autenticarse con el Webhook que acepta y reenvía la notificación. Puedes declarar explícitamente un secreto únicamente en una solicitud que tenga ambas condiciones: Un `notifications.typeName` de `WEBHOOK` Una declaración explícita `notifications.webhookURL` Puede configurar un `webhookSecret` para un valor predeterminado `webhookURL` únicamente en la página Integraciones o con la API de Integraciones. Para declarar explícitamente un `webhookURL` sin un `webhookSecret`, omita este campo. 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.
notificaciones.webhookUrl	string	URL del webhook que activa esta notificación. Si no declara explícitamente `webhookUrl` un, su solicitud usará el valor predeterminado,`webhookUrl` ya sea en la página de Integraciones o 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.
notificaciones.microsoftTeamsWebhookUrl	string	URL del webhook entrante del canal de Microsoft Teams. Obligatorio si `"notifications.typeName" : "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.
notificaciones.númeromóvil	string	Número de móvil al que enviar SMS. Obligatorio si `"notifications.typeName" : "SMS"`.
notificaciones.notificationToken	string	Un token de la API de HipChat. Obligatorio si `"notifications.typeName" : "HIP_CHAT"`. Si posteriormente deja de ser válido, Ops Manager envía un correo electrónico al propietario del proyecto y, finalmente, lo elimina. 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.
notificaciones.role	string	Rol de administrador de operaciones en el proyecto actual. Obligatorio si `"notifications.typeName" : "GROUP"`.
notificaciones.nombreDeLaHabitación	string	Nombre de la sala HipChat. Obligatorio si `"notifications.typeName" : "HIP_CHAT"`.
notificaciones.serviceKey	string	Clave de integración de PagerDuty. Obligatorio si `"notifications.typeName" : "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.
notificaciones.smsHabilitadas	booleano	Bandera que indica que deben enviarse notificaciones por SMS. Obligatorio si: `"notifications.typeName" : "GROUP"` `"notifications.typeName" : "USER"`
notificaciones.teamId	string	Identificador único de un equipo.
notificaciones.typeName	string	Tipo de notificación de alerta. Los valores aceptados son: `DATADOG` `EMAIL` `GROUP` (Proyecto) `HIPCHAT` `ORG` `PAGER_DUTY` `SLACK` `SMS` (Se debe configurar laintegración de Twilio) `SNMP` .. incluye:: /incluye/fact-snmp-alerts-deprecated.rst `USER` `WEBHOOK`
notificaciones.nombre de usuario	string	Nombre de un usuario de Ops Manager al que se enviarán notificaciones. Especifique un usuario en el proyecto que sea propietario de la configuración de alertas. Obligatorio si `"notifications.typeName" : "USER"`.
notifications Required	matriz de objetos	Notificaciones para enviar cuando se detecta una condición de alerta.
operador de umbral	string	Operador a aplicar al comparar el valor de la métrica actual con el valor del umbral. `GREATER_THAN` `LESS_THAN`
umbral.umbral	Número	Valor de umbral fuera del cual se activa una alerta.
límite	Objeto	Umbral que activará una alerta. Obligatorio si: `"eventTypeName" : "TOO_FEW_HEALTHY_MEMBERS"` `"eventTypeName" : TOO_MANY_UNHEALTHY_MEMBERS`

Respuesta

La respuesta incluye los detalles de la configuración de la 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' \
 --header 'Content-Type: application/json' \
 --include \
 --request PUT "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}" \
 --data '
   {
     "eventTypeName" : "RESYNC_REQUIRED",
     "enabled" : true,
     "matchers" : [ {
       "fieldName" : "REPLICA_SET_NAME",
       "operator" : "EQUALS",
       "value" : "rs1"
     } ],
     "notifications" : [ {
       "typeName" : "EMAIL",
       "emailAddress" : "sos@example.com",
       "intervalMin" : 60,
       "delayMin" : 5
     }, {
       "typeName" : "GROUP",
       "intervalMin" : 120,
       "delayMin" : 60,
       "smsEnabled" : true,
       "emailEnabled" : false
     } ]
   }'

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

{
  "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:56:25Z"
}

Volver

Consigue uno

Habilitar/Deshabilitar

Nota

Resource

Nota

Parámetros de la ruta de solicitud

Parámetros de consulta de solicitud

Parámetros del cuerpo de la solicitud

Nota

Ejemplo

Respuesta

Nota

Importante

Ejemplo de solicitud

Ejemplo de respuesta

Encabezado de respuesta

Cuerpo de respuesta