Crear una configuración de alerta global.
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 punto final no utiliza parámetros del cuerpo de la solicitud HTTP.
Parámetros de consulta de solicitud
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
bonita | booleano | Opcional | Bandera que indica si el cuerpo de la respuesta debe estar en un impresión bonita formato. |
| ||||||
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:
|
|
Parámetros del cuerpo de la solicitud
Body Parameter | Tipo | Necesidad | Descripción |
|---|---|---|---|
| booleano | Opcional | Alternador 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, 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. |
| booleano | Requerido | Opción que especifica si la configuración de alerta global se aplica a todos los grupos. También determina si se puede usar la matriz Si es Si es |
| matriz de cadenas | Opcional | ID de los grupos a los que se aplica esta configuración de alerta. Este campo solo se aplica si |
| matriz de objetos | Condicional | Reglas que se aplican al comparar un objeto con esta configuración de alerta global. Ops Manager solo verifica las entidades que cumplen todas estas reglas para una condición de alerta. Puede filtrar utilizando la matriz |
matchers.fieldName | string | Condicional | Nombre del campo en el objeto de destino en el que se va a realizar la coincidencia.
Todos los demás tipos de alertas no admiten comparadores. |
matchers.operator | string | Condicional | Operador para comprobar 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 que se va a comprobar. Admite los mismos valores que el |
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 de 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 |
| matriz de objetos | Requerido | Notificaciones que Ops Manager envía cuando detecta una alerta que describe esta configuración de alerta. |
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 se acepta para notificaciones |
notifications.delayMin | Número | Condicional | Número de minutos que se deben esperar después de que se detecta 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 de espera entre notificaciones sucesivas de alertas no reconocidas y no resueltas que activa esta configuración de alerta. |
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:
Puede 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 que se incluyen en las notificaciones de webhook. Puede usar variables en la plantilla que se reemplazan con valores específicos de la alerta al enviar la notificación. |
notifications.webhookBodyTemplate | string | Opcional | Plantilla para el contenido del cuerpo de las notificaciones de webhook. Puede usar variables en la plantilla que se reemplazan con valores específicos de la alerta al enviar 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 notificaciones |
notifications.roomName | string | Condicional | Nombre de la sala HipChat. Solo se acepta para |
notifications.serviceKey | string | Condicional | Clave de integración de PagerDuty. Sólo aceptado para notificaciones Todas las nuevas claves de PagerDuty usan la API2 de eventos v. Si tiene una1 clave de la API de eventos v, puede seguir usándola con Ops Manager. |
notifications.smsEnabled | booleano | Condicional | Activa o desactiva el envío de notificaciones SMS por parte de Ops Manager. Solo se acepta para las 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 activa esta configuración de alerta. Solo es necesario si
|
threshold.operator | string | Condicional | Operador que se aplica al comparar el valor de la métrica actual con
|
threshold.threshold | Número | Condicional | Valor de umbral fuera del cual esta configuración de alerta activa una alerta. |
| matriz 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 formato ISO 8601 de fecha y hora en UTC cuando se creó la configuración de alerta. |
| booleano | Alternador 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, 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. |
| booleano | Opción que especifica si la configuración de alerta global se aplica a todos los grupos. También determina si se puede usar la matriz Si es Si es |
| matriz de cadenas | ID de los grupos a los que se aplica esta configuración de alerta. Este campo solo se aplica si |
| string | Identificador único de la configuración de la alerta. |
| matriz de objetos | Reglas que se aplican al comparar un objeto con esta configuración de alerta global. Ops Manager solo verifica las entidades que cumplen todas estas reglas para una condición de alerta. Puede filtrar utilizando la matriz |
| string | Nombre del campo en el objeto de destino en el que se va a realizar la coincidencia.
Todos los demás tipos de alertas no admiten comparadores. |
| string | Operador para comprobar el valor del campo. Los valores posibles son:
|
| string | Valor a probar con el operador especificado. Si
|
| Objeto | Umbral que activa esta configuración de alerta. Solo está presente si |
| string | Nombre de la métrica que se va a comprobar. Admite los mismos valores que el |
| string | Esto se establece en |
| string | Operador que se aplica al comparar el valor de la métrica actual con
|
| Número | Valor de 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 |
| matriz de objetos | Notificaciones que Ops Manager envía cuando detecta una alerta que describe esta configuración de alerta. |
| string | Token de API de Slack o token de bot. Solo está presente en las notificaciones 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 está presente para |
| Número | Número de minutos que se deben esperar después de que se detecta 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 de espera entre notificaciones sucesivas de alertas no reconocidas y no resueltas que activa esta configuración de alerta. |
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
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
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] .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. Ops Manager 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 está presente en las notificaciones 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 HipChat. Solo presente para |
| 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 el envío de notificaciones SMS por parte de Ops Manager. Solo está presente para las notificaciones |
| string | Tipo de notificación de alerta que activa esta configuración. 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 de umbral fuera del cual esta configuración de alerta activa una alerta. |
| matriz de cadenas | Etiquetas asociadas con esta configuración de alerta. |
| string | Este campo está obsoleto y será ignorado. |
| 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
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 }
Ejemplo de respuesta
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}
Cuerpo de respuesta
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 }