/ /

Mediciones y alertas

Configuraciones globales de alertas

Docs Home

MongoDB Ops Manager

API

Recursos

Mediciones y alertas

Configuraciones globales de alertas

Obtenga todas las alertas abiertas activadas por una configuración de alerta global

Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de MongoDB Ops Manager.

Recuperar todas las alertas abiertas activadas por una configuración de alerta global identificada por su GLOBAL-ALERT-CONFIG-ID.

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/{GLOBAL-ALERT-CONFIG-ID}/alerts

Parámetros de la ruta de solicitud

Nombre	Tipo	Necesidad	Descripción
`{GLOBAL-ALERT-CONFIG-ID}`	string	Requerido	Identificador único de la configuración global de alerta para la que deseas recuperar las alertas abiertas.

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 formato prettyprint 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 `results` es un sobre. Ops Manager añade el campo `status` al cuerpo de la respuesta.	`false`
trabajos de respaldo habilitados solamente	booleano	Opcional	Indicador que indica si se deben excluir de la respuesta los daemons no habilitados para realizar copias de seguridad de bases de datos. Establezca este valor en `false` para incluir las configuraciones de daemon con el indicador `backupJobsEnabled` establecido en `false`.	`true`

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 alerta.

Nombre

Tipo

Descripción

acknowledgedUntil

string

Marca de tiempo en formato ISO 8601 (UTC) en la que se confirmó la alerta. Ops Manager muestra este campo si un usuario confirmó la alerta.

acknowledgementComment

string

Comentario que abandonó el usuario que reconoció esta alerta. Ops Manager muestra este campo si un usuario reconoció esta alerta.

acknowledgingUsername

string

Nombre de usuario de Ops Manager del usuario que confirmó la alerta. Ops Manager muestra este campo si un usuario confirmó la alerta.

alertConfigId

string

Identificador único de la configuración de alerta global que activó esta alerta.

clusterId

string

Identificador único del clúster al que se aplica esta alerta. Ops Manager devuelve este campo para las alertas globales en las categorías:

clusterName

string

Nombre el clúster al que se aplica esta alerta. Ops Manager devuelve este campo para las alertas globales en las categorías:

created

string

Marca de tiempo en formato ISO 8601 fecha y hora en UTC cuando se creó la alerta.

currentValue

Objeto

Valor actual de la métrica que activó la alerta. Ops Manager devuelve este campo para las alertas globales de la categoría de host.

currentValue.number

Número

Valor actual de la métrica.

currentValue.units

string

Unidades para currentValue.number. 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.

eventTypeName

string

Nombre del evento que activó la 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.

groupId

string

Identificador único del proyecto para el cual se abrió esta alerta.

hostId

string

Identificador único del host al que pertenece la métrica. Ops Manager devuelve este campo para las alertas globales en las categorías:

hostnameAndPort

string

Nombre de host y puerto de cada host al que se aplica la alerta. El nombre de host solo puede ser un nombre de host, un FQDN, una dirección IPv o una dirección IPv. Ops Manager devuelve4 este campo para las alertas globales en las siguientes6 categorías:

id

string

Identificador único de la alerta.

lastNotified

string

Marca de tiempo en formato ISO 8601 de fecha y hora UTC del último envío de notificación para esta alerta. Ops Manager la muestra si envió notificaciones.

metricName

string

Nombre de la medición cuyo valor superó el umbral. Ops Manager devuelve este campo si es "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD".

Para posibles valores, consulta Tipos de mediciones para alertas globales.

replicaSetName

string

Nombre del set de réplicas. Ops Manager devuelve este campo para alertas globales en las categorías de:

resolved

string

Marca de tiempo en formato ISO,8601 fecha y hora UTC del cierre de la alerta. Ops Manager devuelve este campo para las alertas globales "status" : "CLOSED" cuando.

sourceTypeName

string

Tipo de host del que se realiza la copia de seguridad. Ops Manager devuelve este campo para las alertas globales en la categoría de copia de seguridad. Los valores que se pueden devolver incluyen:

REPLICA_SET
SHARDED_CLUSTER
CONFIG_SERVER

status

string

Estado actual de la alerta. Los valores que se pueden devolver incluyen:

`TRACKING`	Existen condiciones de alerta, pero la condición no ha persistido durante el tiempo suficiente como para activar una alerta.
`OPEN`	La alerta está abierta.
`CLOSED`	La alerta está cerrada.
`CANCELLED`	La alerta está cancelada.

tags

matriz de cadenas

Etiquetas asociadas a esta alerta.

typeName

string

Este campo está obsoleto y será ignorado.

updated

string

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando esta alerta fue actualizada por última vez.

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/{GLOBAL-ALERT-CONFIG-ID}/alerts"

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   "results": [{
4     "alertConfigId": "{ALERT-CONFIG-ID}",
5     "created": "2019-11-29T20:26:30Z",
6     "eventTypeName": "BACKUP_AGENT_DOWN",
7     "groupId": "{PROJECT-ID}",
8     "id": "{ALERT-ID}",
9     "lastNotified": "2020-04-09T20:21:00Z",
10     "links": [],
11     "status": "OPEN",
12     "tags": [],
13     "typeName": "AGENT",
14     "updated": "2019-11-29T20:26:30Z"
15   },
16   {
17     "alertConfigId": "{ALERT-CONFIG-ID}",
18     "created": "2019-11-29T20:43:00Z",
19     "eventTypeName": "BACKUP_AGENT_DOWN",
20     "groupId": "{PROJECT-ID}",
21     "id": "{ALERT-ID}",
22     "lastNotified": "2020-04-09T20:21:54Z",
23     "links": [],
24     "status": "OPEN",
25     "tags": [],
26     "typeName": "AGENT",
27     "updated": "2019-11-29T20:43:00Z"
28   },
29   {
30     "alertConfigId": "{ALERT-CONFIG-ID}",
31     "created": "2019-11-30T12:27:07Z",
32     "eventTypeName": "BACKUP_AGENT_DOWN",
33     "groupId": "{PROJECT-ID}",
34     "id": "{ALERT-ID}",
35     "lastNotified": "2020-04-09T20:20:33Z",
36     "links": [],
37     "status": "OPEN",
38     "tags": [],
39     "typeName": "AGENT",
40     "updated": "2019-11-30T12:27:07Z"
41   }
42   ],
43   "totalCount": 3
44 }

Volver

Obtener todo

Consigue uno

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/{GLOBAL-ALERT-CONFIG-ID}/alerts"

1	{
2	"links": [],
3	"results": [{
4	"alertConfigId": "{ALERT-CONFIG-ID}",
5	"created": "2019-11-29T20:26:30Z",
6	"eventTypeName": "BACKUP_AGENT_DOWN",
7	"groupId": "{PROJECT-ID}",
8	"id": "{ALERT-ID}",
9	"lastNotified": "2020-04-09T20:21:00Z",
10	"links": [],
11	"status": "OPEN",
12	"tags": [],
13	"typeName": "AGENT",
14	"updated": "2019-11-29T20:26:30Z"
15	},
16	{
17	"alertConfigId": "{ALERT-CONFIG-ID}",
18	"created": "2019-11-29T20:43:00Z",
19	"eventTypeName": "BACKUP_AGENT_DOWN",
20	"groupId": "{PROJECT-ID}",
21	"id": "{ALERT-ID}",
22	"lastNotified": "2020-04-09T20:21:54Z",
23	"links": [],
24	"status": "OPEN",
25	"tags": [],
26	"typeName": "AGENT",
27	"updated": "2019-11-29T20:43:00Z"
28	},
29	{
30	"alertConfigId": "{ALERT-CONFIG-ID}",
31	"created": "2019-11-30T12:27:07Z",
32	"eventTypeName": "BACKUP_AGENT_DOWN",
33	"groupId": "{PROJECT-ID}",
34	"id": "{ALERT-ID}",
35	"lastNotified": "2020-04-09T20:20:33Z",
36	"links": [],
37	"status": "OPEN",
38	"tags": [],
39	"typeName": "AGENT",
40	"updated": "2019-11-30T12:27:07Z"
41	}
42	],
43	"totalCount": 3
44	}

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