Docs Home

/ /

Configuraciones globales de alertas

Docs Home

/ /

Mediciones y alertas

Configuraciones globales de alertas

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Mediciones y alertas

Configuraciones globales de alertas

Obtenga todas las configuraciones de alertas globales

Recuperar todas las configuraciones 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

GET /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
número de página	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
artículos por página	Número	Opcional	Número de artículos a devolver por página, hasta un máximo de 500.	`100`
bonita	booleano	Opcional	Bandera que indica si el cuerpo de la respuesta debe estar en un impresión bonita 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 una lista de resultados, el objeto `content` es un sobre. Ops Manager añade el campo `status` al cuerpo de la respuesta.	`false`

Parámetros del cuerpo de la solicitud

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

Documento de respuesta

El documento JSON de respuesta incluye una matriz de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.

Nombre	Tipo	Descripción
`results`	arreglo	La matriz incluye un objeto para cada elemento detallado en la `results` sección Documento incrustado.
`links`	arreglo	La matriz incluye uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.
`totalCount`	Número	Número entero del número total de elementos en el conjunto de resultados. Puede ser mayor que el número de objetos en la matriz results si todo el conjunto de resultados está paginado.

`results` Documento incrustado

Cada resultado es una configuración de alerta.

Nombre	Tipo	Descripción
`created`	string	Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando se creó la configuración de alerta.
`enabled`	booleano	Alternador que especifica si la configuración de alerta está habilitada.
`eventTypeName`	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.
`forAllGroups`	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 `tags` para dirigir la configuración a grupos específicos. Si es `true`, la configuración se aplica a todos los grupos. Puede dirigir la configuración de alertas a grupos específicos mediante la matriz `tags`. Si es `false`, la configuración solo se aplica a los grupos especificados en la matriz `groupIds`. Debe especificar al menos un proyecto en la matriz `groupIds`. No puede usar la matriz `tags` para esta configuración de alerta.
`groupIds`	matriz de cadenas	ID de los grupos a los que se aplica esta configuración de alerta. Este campo solo se aplica si `forAllGroups` está configurado como `false`.
`id`	string	Identificador único de la configuración de la alerta.
`matchers`	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 `matchers` solo cuando `eventTypeName` especifica un evento para un host, un conjunto de réplicas o un clúster fragmentado.
`matchers.fieldName`	string	Nombre del campo en el objeto de destino en el que se va a realizar la coincidencia. 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.
`matchers.operator`	string	Operador para comprobar el valor del campo. Los valores posibles son: `EQUALS` `NOT_EQUALS` `CONTAINS` `NOT_CONTAINS` `STARTS_WITH` `ENDS_WITH` `REGEX`
`matchers.value`	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`
`metricThreshold`	Objeto	Umbral que activa esta configuración de alerta. Solo está presente si `eventTypeName` está configurado en `OUTSIDE_METRIC_THRESHOLD`.
`metricThreshold.metricName`	string	Nombre de la métrica que se va a comprobar. Admite los mismos valores que el `metricName` campo del `globalAlerts` recurso. Para obtener una lista de valores posibles, consulte Tipos de medición para alertas globales.
`metricThreshold.mode`	string	Esto se establece en `AVERAGE` y calcula el valor métrico actual como un promedio.
`metricThreshold.operator`	string	Operador que se aplica al comparar el valor de la métrica actual con `metricThreshold.threshold`. Los valores posibles son: `GREATER_THAN` `LESS_THAN`
`metricThreshold.threshold`	Número	Valor de umbral fuera del cual esta configuración de alerta activa una alerta.
`metricThreshold.units`	string	Unidades para `metricThreshold.threshold`. Las unidades dependen del tipo de métrica. Los valores aceptados son: `RAW` `BITS` `BYTES` `KILOBITS` `KILOBYTES` `MEGABITS` `MEGABYTES` `GIGABITS` `GIGABYTES` `TERABYTES` `PETABYTES` `MILLISECONDS` `SECONDS` `MINUTES` `HOURS` `DAYS` Por ejemplo, una métrica que mide el consumo de memoria puede usar `BYTES`, mientras que una métrica que mide el tiempo puede usar `HOURS`.
`notifications`	matriz de objetos	Notificaciones que Ops Manager envía cuando detecta una alerta que describe esta configuración de alerta.
`notifications.apiToken`	string	Token de API de Slack o token de bot. Solo está presente en las notificaciones `SLACK`. Si posteriormente deja de ser válido, Ops Manager envía un correo electrónico al propietario del proyecto y 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.
`notifications.channelName`	string	Nombre del canal de Slack. Solo está presente para `SLACK` notificaciones.
`notifications.delayMin`	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.
`notifications.emailAddress`	string	Dirección de correo electrónico para enviar notificaciones. Solo se muestra para `EMAIL` notificaciones.
`notifications.emailEnabled`	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 `GROUP` y `USER`.
`notifications.intervalMin`	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 `notifications.[n].typeName` en `WEBHOOK` y: Establece `notification.[n].webhookSecret` en una cadena no vacía Establece un valor predeterminado `webhookSecret` en la Consola de administración. 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 `webhookUrl` predeterminado en la página de la Consola de administración. 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].typeName` en `WEBHOOK` y se proporciona una plantilla de encabezados personalizados.
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].typeName` en `WEBHOOK` y se proporciona una plantilla de cuerpo personalizada.
notifications.[n] .id	string	Identificador único de la configuración de notificación.
`notifications.microsoftTeamsWebhookUrl`	string	URL de webhook entrante del canal Microsoft Teams. Solo presente para notificaciones `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.notificationToken`	string	Token de la API de HipChat. Solo está presente en las notificaciones `HIP_CHAT`. Si posteriormente deja de ser válido, Ops Manager envía un correo electrónico al propietario del proyecto y 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.
`notifications.roomName`	string	Nombre de la sala HipChat. Solo presente para `HIP_CHAT` notificaciones.
`notifications.serviceKey`	string	Clave de integración de PagerDuty. Solo presente para notificaciones de `PAGER_DUTY`. Si la clave se vuelve inválida más tarde, Ops Manager enviará un correo electrónico al propietario del proyecto y removerá la clave. 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.smsEnabled`	booleano	Activa o desactiva el envío de notificaciones SMS por parte de Ops Manager. Solo está presente para las notificaciones `GROUP` y `USER`.
`notifications.typeName`	string	Tipo de notificación de alerta que activa esta configuración. Los valores posibles son: `ADMIN` `GROUP` `USER` `EMAIL` `SMS` (Disponible solo si Ops Manager está configurado para la integración de Twilio). `HIPCHAT` `SLACK` `PAGER_DUTY`
`notifications.username`	string	Nombre del usuario de Ops Manager a quien se deben enviar las notificaciones. Solo está presente para `USER` notificaciones.
`threshold`	Objeto	Umbral que hace que esta configuración de alerta active una alerta. Solo está presente si `eventTypeName` tiene uno de los siguientes valores: `TOO_FEW_HEALTHY_MEMBERS` `TOO_MANY_UNHEALTHY_MEMBERS`
`threshold.operator`	string	Operador que se aplica al comparar el valor de la métrica actual con `threshold.threshold`. Los valores posibles son: `GREATER_THAN` `LESS_THAN`
`threshold.threshold`	Número	Valor de umbral fuera del cual esta configuración de alerta activa una alerta.
`tags`	matriz de cadenas	Etiquetas asociadas con esta configuración de alerta.
`typeName`	string	Este campo está obsoleto y será ignorado.
`updated`	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      --include \
4      --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs"

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

1 {
2   "links": [
3   ],
4   "results": [
5     {
6       "created": "2019-10-02T12:34:04Z",
7       "enabled": true,
8       "eventTypeName": "RS_BIND_ERROR",
9       "forAllGroups": true,
10       "groupIds": [],
11       "id": "{GLOBAL-ALERT-CONFIG-ID}",
12       "links": [
13       ],
14       "matchers": [],
15       "notifications": [
16         {
17           "delayMin": 0,
18           "intervalMin": 60,
19           "typeName": "ADMIN"
20         }
21       ],
22       "tags": [],
23       "typeName": "BACKUP",
24       "updated": "2019-10-02T12:34:04Z"
25     },
26     {
27       "created": "2019-10-02T12:34:04Z",
28       "enabled": true,
29       "eventTypeName": "BACKUP_TOO_MANY_RETRIES",
30       "forAllGroups": true,
31       "groupIds": [],
32       "id": "{GLOBAL-ALERT-CONFIG-ID}",
33       "links": [
34       ],
35       "matchers": [],
36       "notifications": [
37         {
38           "delayMin": 0,
39           "intervalMin": 60,
40           "typeName": "ADMIN"
41         }
42       ],
43       "tags": [],
44       "typeName": "BACKUP",
45       "updated": "2019-10-02T12:34:04Z"
46     },
47     {
48       "created": "2019-10-02T12:34:04Z",
49       "enabled": true,
50       "eventTypeName": "BACKUP_IN_UNEXPECTED_STATE",
51       "forAllGroups": true,
52       "groupIds": [],
53       "id": "{GLOBAL-ALERT-CONFIG-ID}",
54       "links": [
55       ],
56       "matchers": [],
57       "notifications": [
58         {
59           "delayMin": 0,
60           "intervalMin": 60,
61           "typeName": "ADMIN"
62         }
63       ],
64       "tags": [],
65       "typeName": "BACKUP",
66       "updated": "2019-10-02T12:34:04Z"
67     }
68   ],
69   "totalCount": 3
70 }

Volver

Configuraciones globales de alertas

Recibir todas las alertas abiertas

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--include \
4	--request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs"

1	{
2	"links": [
3	],
4	"results": [
5	{
6	"created": "2019-10-02T12:34:04Z",
7	"enabled": true,
8	"eventTypeName": "RS_BIND_ERROR",
9	"forAllGroups": true,
10	"groupIds": [],
11	"id": "{GLOBAL-ALERT-CONFIG-ID}",
12	"links": [
13	],
14	"matchers": [],
15	"notifications": [
16	{
17	"delayMin": 0,
18	"intervalMin": 60,
19	"typeName": "ADMIN"
20	}
21	],
22	"tags": [],
23	"typeName": "BACKUP",
24	"updated": "2019-10-02T12:34:04Z"
25	},
26	{
27	"created": "2019-10-02T12:34:04Z",
28	"enabled": true,
29	"eventTypeName": "BACKUP_TOO_MANY_RETRIES",
30	"forAllGroups": true,
31	"groupIds": [],
32	"id": "{GLOBAL-ALERT-CONFIG-ID}",
33	"links": [
34	],
35	"matchers": [],
36	"notifications": [
37	{
38	"delayMin": 0,
39	"intervalMin": 60,
40	"typeName": "ADMIN"
41	}
42	],
43	"tags": [],
44	"typeName": "BACKUP",
45	"updated": "2019-10-02T12:34:04Z"
46	},
47	{
48	"created": "2019-10-02T12:34:04Z",
49	"enabled": true,
50	"eventTypeName": "BACKUP_IN_UNEXPECTED_STATE",
51	"forAllGroups": true,
52	"groupIds": [],
53	"id": "{GLOBAL-ALERT-CONFIG-ID}",
54	"links": [
55	],
56	"matchers": [],
57	"notifications": [
58	{
59	"delayMin": 0,
60	"intervalMin": 60,
61	"typeName": "ADMIN"
62	}
63	],
64	"tags": [],
65	"typeName": "BACKUP",
66	"updated": "2019-10-02T12:34:04Z"
67	}
68	],
69	"totalCount": 3
70	}

Roles necesarios

Solicitud

Parámetros de la ruta de solicitud

Parámetros de consulta de solicitud

Parámetros del cuerpo de la solicitud

Respuesta

Documento de respuesta

results Documento incrustado

Ejemplo de solicitud

Ejemplo de respuesta

Encabezado de respuesta

Cuerpo de respuesta

`results` Documento incrustado