/ /

Mediciones y alertas

Configuraciones de Alerta

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Mediciones y alertas

Configuraciones de Alerta

Crear una configuración de alerta

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es lo mismo que tu ID del grupo. Para los grupos existentes, su identificador de grupo/proyecto sigue siendo el mismo. Esta página utiliza el término más familiar "grupo" al referirse a descripciones. El endpoint permanece como se indica en el documento.

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

Resource

POST /groups/{PROJECT-ID}/alertConfigs

Parámetros de 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

bonito

booleano

Opcional

Indicador que señala si el cuerpo de la respuesta debe estar en un pretty-print formato.

false

envelope

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos Los clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar este problema, configure envelope=true en la query.

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

Nota

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

Nombre	Tipo	Necesidad	Descripción
habilitado	booleano	Opcional	Si se omite, la configuración se desactivará.
eventTypeName	string	Requerido	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 revisar la lista completa de eventos que generan alertas y sus descripciones, consulta Tipos de Alertas. Para obtener una lista completa de los eventos incluidos en el registro de auditoría de Ops Manager, consulta Eventos de auditoría.
matchers .fieldName	string	Opcional	Nombre del campo en el objeto de destino con el que hacer coincidir. Las alertas del host admiten estos campos: `HOSTNAME` `PORT` `HOSTNAME_AND_PORT` `REPLICA_SET_NAME` `TYPE_NAME` Las alertas de sets 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 soportan matchers.
matchers .operator	string	Opcional	Operador para probar el valor del campo. Los valores aceptados son: `EQUALS` `NOT_EQUALS` `CONTAINS` `NOT_CONTAINS` `STARTS_WITH` `ENDS_WITH` `REGEX`
matchers .value	string	Opcional	Valor a probar con el operador especificado. Si `matchers.fieldName` está configurado en `TYPE_NAME`, usted puede coincidir con los siguientes valores: `PRIMARY` `SECONDARY` `STANDALONE` `CONFIG` `MONGOS`
comparadores	objeto arreglo	Opcional	Reglas a aplicar al cotejar un objeto con esta configuración de alerta. Solo las entidades que cumplen todas estas reglas son revisadas por una condición de alerta. Puede filtrar utilizando solo el arreglo `matchers` cuando el `eventTypeName` especifica un evento para un host, set de réplicas o clúster.
metricThreshold .metricName	string	Opcional	Nombre de la métrica a comprobar. Admite los mismos valores que el campo `metricName` del recurso `alerts`.
metricThreshold .mode	string	Opcional	Configura en `AVERAGE` para calcular el promedio de esta métrica.
metricThreshold .operator	string	Opcional	Operador a aplicar al verificar el valor actual de la métrica frente al valor umbral. Los valores aceptados son: `GREATER_THAN` `LESS_THAN`
metricThreshold .threshold	Número	Opcional	Valor umbral fuera del cual se activa una alerta.
metricThreshold .units	string	Opcional	Unidades para el valor umbral. Depende del tipo de métrica. Por ejemplo, una métrica que mide el consumo de memoria tendría una medida en bytes, 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`
metricThreshold	Objeto	Condicional	Umbral que provocará la activación de una alerta. Obligatorio si `"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"`.
notifications .apiToken	string	Condicional	Token de API de Slack o token de Bot. Requerido si `"notifications.typeName" : "SLACK"`. Si el token posteriormente se vuelve inválido, Ops Manager enviará un correo electrónico al propietario del Proyecto y, finalmente, 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 .channelName	string	Condicional	Nombre del canal de Slack. Obligatorio si `"notifications.typeName" : "SLACK"`.
notifications .datadogApiKey	string	Condicional	Clave de API de DataDog. Encontrado en el tablero de DataDog. Requerido 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: 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 .delayMin	Número	Opcional	Número de minutos de espera tras detectarse una condición de alerta antes de enviar la primera notificación.
notifications .emailAddress	string	Condicional	Dirección de correo electrónico a la que enviar la notificación. Obligatorio si `"notifications.typeName" : "EMAIL"`.
notifications .emailEnabled	booleano	Condicional	Determina si se deben enviar notificaciones por correo electrónico. Requerido si: `"notifications.typeName" : "GROUP"` `"notifications.typeName" : "USER"`
notifications .intervalMin	Número	Opcional	Número de minutos que deben transcurrir entre notificaciones sucesivas sobre alertas no reconocidas que no se hayan resuelto.
notifications .webhookSecret	string	Opcional	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` Un explícitamente declarado `notifications.webhookURL` Puede configurar un `webhookSecret` para un `webhookURL` por defecto solo en la página de Integraciones, o bien con el API. Para declarar explícitamente un `webhookURL` sin un `webhookSecret`, omita este campo. 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 .webhookUrl	string	Opcional	URL para el webhook que activa esta notificación. Si no declaras explícitamente un `webhookUrl`, tu solicitud utilizará el `webhookUrl` por defecto establecido 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 está parcialmente redactada cuando ves o editas la alerta, y el secreto está completamente redactado.
notifications .webhookHeadersTemplate	string	Opcional	Plantilla para encabezados personalizados para incluir en las notificaciones webhook. Puedes usar variables en la plantilla que se reemplazan con valores específicos de la alerta cuando se envía la notificación.
notifications .webhookBodyTemplate	string	Opcional	Plantilla para el contenido del cuerpo de las notificaciones de webhook. Puedes usar variables en la plantilla que se reemplazan con valores específicos de la alerta cuando se envía la notificación.
notifications .microsoftTeamsWebhookUrl	string	Condicional	URL del webhook entrante del canal de Microsoft Teams. Requerido 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.
notifications .mobileNumber	string	Condicional	Número de móvil al que se enviarán mensajes SMS. Obligatorio si `"notifications.typeName" : "SMS"`.
notifications .notificationToken	string	Condicional	Un token de API de HipChat. Obligatorio si `"notifications.typeName" : "HIP_CHAT"`. Si el token posteriormente se vuelve inválido, Ops Manager envía un correo electrónico al propietario del Proyecto y, en últimas, remueve 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 .role	string	Condicional	Rol de Ops Manager en el proyecto actual. Obligatorio si `"notifications.typeName" : "GROUP"`.
notifications .roomName	string	Condicional	Nombre de la sala de HipChat. Obligatorio si `"notifications.typeName" : "HIP_CHAT"`.
notifications .serviceKey	string	Condicional	Clave de integración PagerDuty. Requerido 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: 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 .smsEnabled	booleano	Condicional	Indica que se deben enviar notificaciones por SMS. Obligatorio si: `"notifications.typeName" : "GROUP"` `"notifications.typeName" : "USER"`
notifications .teamId	string	Opcional	Identificador único de un equipo.
notifications .typeName	string	Opcional	Tipo de notificación de alerta. Los valores aceptados son: `DATADOG` `EMAIL` `GROUP` (Proyecto) `HIPCHAT` `ORG` `PAGER_DUTY` `SLACK` `SMS` (La integración de Twilio debe estar configurada) `USER` `WEBHOOK`
notifications .username	string	Condicional	Nombre de un usuario de Ops Manager al que enviar notificaciones. Especifique un usuario en el Proyecto que posea la configuración de alertas. Requerido si `"notifications.typeName" : "USER"`.
notificaciones	objeto arreglo	Requerido	Notificaciones para enviar cuando se detecta una condición de alerta.
threshold .operator	string	Opcional	Operador que se aplica al comparar el valor de la métrica actual con el valor umbral. `GREATER_THAN` `LESS_THAN`
threshold .threshold	Número	Opcional	Valor umbral fuera del cual se activa una alerta.
umbral	Objeto	Condicional	Umbral que provocará la activación de 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 alertas varían. Una configuración de alerta solo puede incluir un subconjunto de estos elementos.

Nombre	Tipo	Descripción
creado	string	Marca temporal en ISO 8601 fecha y formato de hora en UTC cuando esta configuración de alerta fue creada.
habilitado	booleano	Indicador de que esta configuración de alerta está habilitada.
eventTypeName	string	Tipo de evento que activa una alerta.
ID del grupo	string	Identificador único del Proyecto que posee 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 para aplicar al verificar el valor actual de la métrica con respecto a `matcher.[n].value`.
matchers .[n].value	string	Valor para igualar o superar usando `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 destinos para que Ops Manager envíe notificaciones cuando se detecta una condición de alerta.
notifications.[n] .apiToken	string	Token token de API de Slack. Ops Manager devuelve este valor si se configura `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 que deben transcurrir entre notificaciones sucesivas sobre alertas no reconocidas que no se hayan resuelto.
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 Ops Manager en el Proyecto u organización actuales. Ops Manager devuelve este valor si 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 se deben enviar notificaciones de texto. Ops Manager devuelve este valor si se configura `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 enviar notificaciones. Ops Manager devuelve este valor si se configura `notifications.[n].typeName` en `USER`.
notifications.[n] .victorOpsApiKey	string	VictorOps API key. Si la clave se vuelve inválida, MongoDB Atlas envía un correo electrónico al `Project Owner` y finalmente elimina la 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 la clave se vuelve inválida, MongoDB Atlas envía un correo electrónico al `Project Owner` y finalmente elimina la 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 configuras `notifications.[n].typeName` en `WEBHOOK` y si: Se configuró `notification.[n].webhookSecret` como una string no vacía Has configurado una configuración `webhookSecret` por defecto en la página de Integraciones o 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 configuras `notifications.[n].typeName` en `WEBHOOK` y si: Se configuró `notification.[n].webhookURL` como una string no vacía Has configurado una configuración `webhookUrl` por defecto en la página de Integraciones o 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 incluirán en las notificaciones webhook. El Gestor de Operaciones devuelve este valor si configuras `notifications.[n].typeName` en `WEBHOOK` y proporciona una plantilla de encabezados personalizada.
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.
umbral	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" \
 --header "Content-Type: application/json" \
 --include \
 --request POST "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs" \
 --data '
   {
     "eventTypeName" : "RESYNC_REQUIRED",
     "enabled" : true,
     "notifications" : [ {
       "typeName" : "GROUP",
       "intervalMin" : 5,
       "delayMin" : 0,
       "smsEnabled" : false,
       "emailEnabled" : true
     }, {
       "typeName" : "WEBHOOK",
       "intervalMin" : 5,
       "delayMin" : 0,
       "webhookUrl" : "https://example.com/webhook",
       "webhookSecret" : "secret123",
       "webhookHeadersTemplate" : "{\"X-Alert-Type\": \"{{eventTypeName}}\"}",
       "webhookBodyTemplate" : "{\"alert\": \"{{eventTypeName}}\", \"project\": \"{{groupName}}\"}"
     } ]
   }'

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:29:18Z",
  "enabled" : true,
  "groupId" : "{PROJECT-ID}",
  "id" : "{ALERT-CONFIG-ID}",
  "links" : [],
  "matchers" : [ ],
  "notifications" : [ {
    "id" : "{NOTIFICATION-ID-1}",
    "delayMin" : 0,
    "emailEnabled" : true,
    "intervalMin" : 5,
    "smsEnabled" : false,
    "typeName" : "GROUP"
  }, {
    "id" : "{NOTIFICATION-ID-2}",
    "delayMin" : 0,
    "intervalMin" : 5,
    "typeName" : "WEBHOOK",
    "webhookUrl" : "https://example.com/webhook",
    "webhookSecret" : "***",
    "webhookHeadersTemplate" : "{\"X-Alert-Type\": \"{{eventTypeName}}\"}",
    "webhookBodyTemplate" : "{\"alert\": \"{{eventTypeName}}\", \"project\": \"{{groupName}}\"}"
  } ],
  "updated" : "2014-04-23T14:29:18Z"
}

Volver

Obtener todo para un proyecto

Obtenga uno