Cree una configuración global de alerta.
Roles necesarios
Puede llamar correctamente a este punto final con cualquiera de los siguientes roles asignados:
Solicitud
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
POST /globalAlertConfigs
Parámetros de la ruta de solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Parámetros de Solicitud Query
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. |
| ||||||
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:
|
|
Parámetros del cuerpo de la solicitud
Body Parameter | Tipo | Necesidad | Descripción |
|---|---|---|---|
| booleano | Opcional | Palanca que especifica si la configuración de alerta está habilitada. |
| string | Requerido | Tipo de evento para el cual esta configuración de alerta activa una alerta. Para revisar los tipos de eventos que generan alertas, consulta Tipos de Alertas. Para obtener una lista completa de los eventos incluidos en el registro de auditoría del Ops Manager, consulte Eventos de Auditoría. |
| booleano | Requerido | Alterna que especifica si la configuración global de alertas se aplica a todos los grupos. También afecta si puedes usar el arreglo Si Si |
| Arreglo de cadenas | Opcional | Ids de los grupos a los cuales se aplica esta configuración de alerta. Este campo solo se aplica si |
| Arreglo de objetos | Condicional | Reglas a aplicar al comparar un objeto con esta configuración global de alertas. Ops Manager solo comprueba las entidades que coinciden con todas estas reglas para una condición de alerta. Puede filtrar utilizando solo el arreglo |
matchers.fieldName | string | Condicional | Nombre del campo en el objeto de destino en el que coincidir.
Todos los demás tipos de alertas no soportan matchers. |
matchers.operator | string | Condicional | Operador para probar el valor del campo. Los valores aceptados son:
|
matchers.value | string | Condicional | Valor a probar con el operador especificado. Si
|
| Objeto | Condicional | Umbral que activa esta configuración de alerta. Solo es necesario si |
metricThreshold.metricName | string | Condicional | Nombre de la métrica a comprobar. Admite los mismos valores que el campo |
metricThreshold.mode | string | Condicional | Esto se establece en |
metricThreshold.operator | string | Condicional | Operador que se aplica al comparar el valor de la métrica actual con
|
metricThreshold.threshold | Número | Condicional | Valor umbral fuera del cual esta configuración de alerta activa una alerta. |
metricThreshold.units | string | Condicional | Unidades para Los valores aceptados son:
Por ejemplo, una métrica que mide el consumo de memoria puede usar |
| Arreglo de objetos | Requerido | Notificaciones que Ops Manager envía cuando detecta una alerta que esta configuración de alerta describe. |
notifications.apiToken | string | Condicional | Token de API de Slack o token de Bot. Sólo aceptado para notificaciones |
notifications.channelName | string | Condicional | Nombre del canal de Slack. Solo aceptado para notificaciones de |
notifications.delayMin | Número | Condicional | Número de minutos que se debe esperar después de que se detecte una condición de alerta antes de que Ops Manager envíe la primera notificación. |
notifications.emailAddress | Condicional | Opcional | Dirección de correo electrónico para enviar notificaciones. Solo se acepta para |
notifications.emailEnabled | booleano | Condicional | Cambiar especificar si Ops Manager envía notificaciones por correo electrónico. Solo se aceptan para |
notifications.intervalMin | Número | Condicional | Número de minutos que se deben esperar entre notificaciones sucesivas para alertas no reconocidas y no resueltas que esta configuración de alerta activa. |
notifications.webhookSecret | string | Condicional | 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:
Puedes configurar un Para declarar explícitamente un |
notifications.webhookUrl | string | Opcional | URL del webhook que activa estas notificaciones. Si no declaras explícitamente un |
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 de webhook entrante del canal Microsoft Teams. Solo se acepta para notificaciones |
notifications.notificationToken | string | Condicional | Token de la API de HipChat. Solo se acepta para |
notifications.roomName | string | Condicional | Nombre del cuarto de HipChat. Sólo aceptado para notificaciones de |
notifications.serviceKey | string | Condicional | Clave de integración de PagerDuty. Sólo aceptado para notificaciones Todas las nuevas claves de PagerDuty utilizan su Events API v2. Si tienes una llave API de Eventos v1, puedes seguir utilizándola con Ops Manager. |
notifications.smsEnabled | booleano | Condicional | Alternar la especificación de si Ops Manager envía notificaciones por SMS. Solo se acepta para notificaciones |
notifications.typeName | string | Requerido | Tipo de notificación de alerta que activa esta configuración. Los valores aceptados son:
|
notifications.username | string | Condicional | Nombre del usuario de Ops Manager a quien se deben enviar las notificaciones. Solo está presente para |
| Objeto | Condicional | Umbral que hace que esta configuración de alerta active una alerta. Solo es requerido si
|
threshold.operator | string | Condicional | Operador a aplicar al comprobar el valor de la métrica actual respecto a
|
threshold.threshold | Número | Condicional | Valor umbral fuera del cual esta configuración de alerta activa una alerta. |
| Arreglo de cadenas | Opcional | Etiquetas asociadas con esta configuración de alerta. |
| string | Opcional | Este campo está obsoleto y será ignorado. |
Respuesta
Nombre | Tipo | Descripción |
|---|---|---|
| string | Marca de tiempo en ISO 8601 en el formato de fecha y hora en UTC cuando se creó la configuración de la alerta. |
| booleano | Palanca que especifica si la configuración de alerta está habilitada. |
| string | Tipo de evento para el cual esta configuración de alerta activa una alerta. Para revisar los tipos de eventos que generan alertas, consulta Tipos de Alertas. Para obtener una lista completa de los eventos incluidos en el registro de auditoría del Ops Manager, consulte Eventos de Auditoría. |
| booleano | Alterna que especifica si la configuración global de alertas se aplica a todos los grupos. También afecta si puedes usar el arreglo Si Si |
| Arreglo de cadenas | Ids de los grupos a los cuales se aplica esta configuración de alerta. Este campo solo se aplica si |
| string | Identificador único de la configuración de la alerta. |
| Arreglo de objetos | Reglas a aplicar al comparar un objeto con esta configuración global de alertas. Ops Manager solo comprueba las entidades que coinciden con todas estas reglas para una condición de alerta. Puede filtrar utilizando solo el arreglo |
| string | Nombre del campo en el objeto de destino en el que coincidir.
Todos los demás tipos de alertas no soportan matchers. |
| string | Operador para probar el valor del campo. Los valores posibles son:
|
| string | Valor a probar con el operador especificado. Si
|
| Objeto | Umbral que hace que esta configuración de alerta active una alerta. Solo está presente si |
| string | Nombre de la métrica a comprobar. Admite los mismos valores que el campo |
| string | Esto se establece en |
| string | Operador que se aplica al comparar el valor de la métrica actual con
|
| Número | Valor umbral fuera del cual esta configuración de alerta activa una alerta. |
| string | Unidades para Los valores aceptados son:
Por ejemplo, una métrica que mide el consumo de memoria puede usar |
| Arreglo de objetos | Notificaciones que Ops Manager envía cuando detecta una alerta que esta configuración de alerta describe. |
| string | Token de API de Slack o token de Bot. Solo presente para 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:
|
| string | Nombre del canal de Slack. Solo presente para |
| Número | Número de minutos que se debe esperar después de que se detecte una condición de alerta antes de que Ops Manager envíe la primera notificación. |
| string | Dirección de correo electrónico para enviar notificaciones. Solo se muestra para |
| booleano | Activa o desactiva la opción para especificar si Ops Manager envía notificaciones por correo electrónico. Solo está presente para las notificaciones |
| Número | Número de minutos que se deben esperar entre notificaciones sucesivas para alertas no reconocidas y no resueltas que esta configuración de alerta activa. |
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
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
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] .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] .id | string | Identificador único de la configuración de notificación. |
| string | URL de webhook entrante del canal Microsoft Teams. Solo presente para notificaciones Cuando se ve o edita la alerta de una notificación de webhook, la URL aparece parcialmente oculta y el secreto aparece completamente oculto. |
| string | Token de la API de HipChat. Solo presente para 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:
|
| string | Nombre de la sala de HipChat. Solo estará presente para las notificaciones |
| string | Clave de integración de PagerDuty. Solo presente para notificaciones de 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:
|
| booleano | Activa o desactiva la indicación de si Ops Manager envía notificaciones por SMS. Solo presente para notificaciones de |
| string | Tipo de notificación de alerta que activa esta configuración de alerta. Los valores posibles son:
|
| string | Nombre del usuario de Ops Manager a quien se deben enviar las notificaciones. Solo está presente para |
| Objeto | Umbral que hace que esta configuración de alerta active una alerta. Solo está presente si
|
| string | Operador que se aplica al comparar el valor de la métrica actual con
|
| Número | Valor umbral fuera del cual esta configuración de alerta activa una alerta. |
| Arreglo de cadenas | Etiquetas asociadas con esta configuración de alerta. |
| string | Este campo está obsoleto y será ignorado. |
| 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
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs \ 6 --data '{ 7 "enabled": true, 8 "eventTypeName": "BACKUP_AGENT_DOWN", 9 "forAllGroups": true, 10 "groupIds": [], 11 "matchers": [], 12 "notifications": [ 13 { 14 "delayMin": 0, 15 "intervalMin": 60, 16 "typeName": "ADMIN" 17 }, 18 { 19 "delayMin": 0, 20 "intervalMin": 60, 21 "typeName": "WEBHOOK", 22 "webhookUrl": "https://example.com/webhook", 23 "webhookSecret": "secret123", 24 "webhookHeadersTemplate": "{\"X-Alert-Type\": \"{{eventTypeName}}\"}", 25 "webhookBodyTemplate": "{\"alert\": \"{{eventTypeName}}\", \"type\": \"{{typeName}}\"}" 26 } 27 ], 28 "tags": [], 29 "typeName": "AGENT" 30 }
Respuesta de ejemplo
Encabezado de respuesta
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
201 Created 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
1 { 2 "created": "2019-10-02T12:34:04Z", 3 "enabled": true, 4 "eventTypeName": "BACKUP_AGENT_DOWN", 5 "forAllGroups": true, 6 "groupIds": [], 7 "id": "{GLOBAL-ALERT-CONFIG-ID}", 8 "links": [ 9 ], 10 "matchers": [], 11 "notifications": [ 12 { 13 "id": "{NOTIFICATION-ID-1}", 14 "delayMin": 0, 15 "intervalMin": 60, 16 "typeName": "ADMIN" 17 }, 18 { 19 "id": "{NOTIFICATION-ID-2}", 20 "delayMin": 0, 21 "intervalMin": 60, 22 "typeName": "WEBHOOK", 23 "webhookUrl": "https://example.com/webhook", 24 "webhookSecret": "***", 25 "webhookHeadersTemplate": "{\"X-Alert-Type\": \"{{eventTypeName}}\"}", 26 "webhookBodyTemplate": "{\"alert\": \"{{eventTypeName}}\", \"type\": \"{{typeName}}\"}" 27 } 28 ], 29 "tags": [], 30 "typeName": "AGENT", 31 "updated": "2019-10-02T12:34:04Z" 32 }