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

Obtener todas las configuraciones de alertas globales

Recuperar todas las configuraciones globales de alertas.

Roles necesarios

Puede llamar a este endpoint con éxito con cualquiera de los siguientes roles asignados:

Solicitud

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

GET /globalAlertConfigs

Parámetros de 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
Num. de pág.	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
elementosPorPágina	Número	Opcional	Número de elementos a devolver por página, hasta un máximo de 500.	`100`
bonito	booleano	Opcional	Bandera que indica si el cuerpo de la respuesta debe estar en una 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 remediarlo, establezca `envelope : true` en la query. Para los endpoints que devuelven una lista de resultados, el objeto `results` es un sobre. Ops Manager agrega el campo `status` al cuerpo de la respuesta.	`false`
backupJobsEnabledOnly	booleano	Opcional	Indicador que indica si se deben excluir los demonios que no están habilitados para hacer copias de seguridad de bases de datos de la respuesta. Establece esto en `false` para incluir las configuraciones del demonio con la bandera `backupJobsEnabled` establecida en `false`.	`true`

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Documento de respuesta

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

Nombre	Tipo	Descripción
`results`	arreglo	El arreglo incluye un objeto para cada elemento detallado en la sección del `results` documento incrustado.
`links`	arreglo	El arreglo incluye uno o más enlaces a subrecursos y/o recursos relacionados. Las relaciones entre URLse explican en la Especificación de enlace web.
`totalCount`	Número	Recuento entero del número total de elementos en el conjunto de resultados. Puede ser superior al número de objetos en el arreglo results si el conjunto de resultados completo está paginado.

`results` embeddedDocument

Cada resultado es una configuración de alerta.

Nombre	Tipo	Descripción
`created`	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.
`enabled`	booleano	Palanca 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, 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.
`forAllGroups`	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 `tags` para orientar la configuración a grupos específicos. Si `true`, la configuración aplica a todos los grupos. Puedes orientar la configuración de alertas a grupos específicos a través del `tags` arreglo. Si `false`, la configuración solo se aplica a los grupos especificados en el arreglo `groupIds`. Se debe especificar al menos un proyecto en el arreglo `groupIds`. No puedes utilizar el arreglo `tags` para esta configuración de alerta.
`groupIds`	Arreglo de cadenas	Ids de los grupos a los cuales se aplica esta configuración de alerta. Este campo solo se aplica si `forAllGroups` está configurado en `false`.
`id`	string	Identificador único de la configuración de la alerta.
`matchers`	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 `matchers` cuando el `eventTypeName` especifica un evento para un host, set de réplicas o clúster.
`matchers.fieldName`	string	Nombre del campo en el objeto de destino en el que 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	Operador para probar 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` está configurado en `TYPE_NAME`, usted puede coincidir con los siguientes valores: `PRIMARY` `SECONDARY` `STANDALONE` `CONFIG` `MONGOS`
`metricThreshold`	Objeto	Umbral que hace que esta configuración de alerta active una alerta. Solo está presente si `eventTypeName` se establece en `OUTSIDE_METRIC_THRESHOLD`.
`metricThreshold.metricName`	string	Nombre de la métrica a comprobar. Admite los mismos valores que el campo `metricName` del recurso `globalAlerts`. Para obtener una lista de valores posibles, consulta 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 comprobar el valor actual de la métrica respecto a `metricThreshold.threshold`. Los valores posibles son: `GREATER_THAN` `LESS_THAN`
`metricThreshold.threshold`	Número	Valor 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 utilizar `BYTES`, mientras que una métrica que mide el tiempo puede utilizar `HOURS`.
`notifications`	Arreglo de objetos	Notificaciones que Ops Manager envía cuando detecta una alerta que esta configuración de alerta describe.
`notifications.apiToken`	string	Token de API de Slack o token de Bot. Solo presente para `SLACK` notificaciones. Si el token posteriormente se vuelve inválido, Ops Manager enviará un correo electrónico al propietario del proyecto y 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	Nombre del canal de Slack. Solo presente para `SLACK` notificaciones.
`notifications.delayMin`	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.
`notifications.emailAddress`	string	Dirección de correo electrónico a la que se debe enviar la notificación. Solo presente para `EMAIL` notificaciones.
`notifications.emailEnabled`	booleano	Active o desactive la opción que especifica si Ops Manager envía notificaciones por correo electrónico. Solo presente para las notificaciones de `GROUP` y `USER`.
`notifications.intervalMin`	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 configuras `notifications.[n].typeName` en `WEBHOOK` y si: Se configuró `notification.[n].webhookSecret` como una string no vacía Se establece un(a) `webhookSecret` por defecto en la Consola de Administración. 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 Se ha establecido un `webhookUrl` por defecto en la página Consola de administración. 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.
`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 presente para `HIP_CHAT` notificaciones. Si el token posteriormente se vuelve inválido, Ops Manager enviará un correo electrónico al propietario del proyecto y 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.roomName`	string	Nombre de la sala de HipChat. Solo estará presente para las notificaciones `HIP_CHAT`.
`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: 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	Activa o desactiva la indicación de si Ops Manager envía notificaciones por SMS. Solo presente para notificaciones de `GROUP` y `USER`.
`notifications.typeName`	string	Tipo de notificación de alerta que activa esta configuración de alerta. 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 alertas active una alerta. Solo se presenta si `eventTypeName` está configurado con uno de los siguientes valores: `TOO_FEW_HEALTHY_MEMBERS` `TOO_MANY_UNHEALTHY_MEMBERS`
`threshold.operator`	string	Operador que se aplica al comprobar el valor actual de la métrica respecto a `threshold.threshold`. Los valores posibles son: `GREATER_THAN` `LESS_THAN`
`threshold.threshold`	Número	Valor umbral fuera del cual esta configuración de alerta activa una alerta.
`tags`	Arreglo 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 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      --include \
4      --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs"

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

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

Obtener 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 ruta de solicitud

Parámetros de Solicitud Query

Parámetros del cuerpo de la solicitud

Respuesta

Documento de respuesta

results embeddedDocument

Solicitud de ejemplo

Respuesta de ejemplo

Encabezado de respuesta

Respuesta del cuerpo

`results` embeddedDocument