/ /

/ /

Gerente de Operaciones

Obtenga todos los eventos globales

Roles necesarios

Su clave API debe tener la Global Read Only rol para llamar a este recurso exitosamente.

Solicitud

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

GET /globalEvents

Parámetros de la ruta de solicitud

Este punto final no utiliza parámetros de ruta de solicitud HTTP.

Parámetros de consulta de solicitud

Parámetros de consulta únicos

Este punto final acepta los siguientes parámetros de consulta para filtrar los eventos devueltos:

Nombre	Tipo	Descripción
minDate	string	Devuelve solo eventos para los cuales la fecha de creación es mayor o igual a la marca de tiempo especificada en ISO 8601 formato de fecha y hora en Hora UTC.
fecha máxima	string	Devuelve solo eventos cuya fecha de creación sea menor o igual a la marca de tiempo especificada en formato de fecha y hora ISO 8601 en UTC.
tipo de evento	string	Devuelve solo eventos de los tipos especificados. Los valores aceptados incluyen: 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.

Parámetros de consulta comunes

Este punto final también acepta los parámetros de consulta comunes a todos los puntos finales que devuelven listas de valores:

Nombre

Tipo

Descripción

predeterminado

número de página

entero

Número de página (basado en el índice 1).

1

artículos por página

entero

Número de artículos a devolver por página, hasta un máximo de 500.

100

bonita

booleano

Indica si el cuerpo de la respuesta debe estar en formato prettyprint.

false

envolvente

booleano

Indica si se debe envolver o no la respuesta en un sobre.

Algunos clientes de API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionarlo, configure "envelope" : true en la consulta.

Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuestaHTTP
`content`	Cuerpo de respuesta esperado

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.

Ninguno

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 un evento.

Nombre	Tipo	Descripción
alertId	string	Identificador único de la alerta asociada a este evento.
alertConfigId	string	Identificador único para la configuración de alerta asociada con `alertId`.
apiKeyId	string	Identificador único de la clave API que activó este evento. Si este campo está presente en la respuesta, Ops Manager no devuelve el campo `userId`.
clusterId	string	Identificador único del clúster al que se aplica este evento.
nombre del clúster	string	Nombre del clúster al que se aplica este evento.
Colección	string	Nombre de la colección donde ocurrió el evento. Este campo puede estar presente cuando `eventTypeName` es `DATA_EXPLORER` o `DATA_EXPLORER_CRUD`.
creado	string	Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando se activó este evento.
valorActual	Objeto	Valor actual de la métrica que activó este evento.
currentValue .number	Número	Valor 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`.
database	string	Nombre de la base de datos donde ocurrió el evento. Este campo puede estar presente cuando `eventTypeName` es `DATA_EXPLORER` o `DATA_EXPLORER_CRUD`.
nombreDeTipoDeEvento	string	Nombre de la circunstancia que desencadenó este evento. 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.
ID de grupo	string	Identificador único del proyecto en el que ocurrió este evento.
ID de host	string	Identificador único del host en el que ocurrió este evento.
Nombre del host	string	Nombre dehost, FQDN, direcciónIPv4 o dirección IPv del host en el que ocurrió este evento.6
ID.	string	Identificador único para este evento.
esGlobalAdmin	booleano	Bandera que indica si el usuario que activó este evento tiene el rol `Global Monitoring Administrator`.
enlaces	matriz de objetos	Uno o más enlaces a subrecursos o recursos relacionados. Todas las `links` matrices en las respuestas incluyen al menos un enlace `self` llamado. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.
nombremétrico	string	Nombre de la medida cuyo valor salió del umbral. Para ver los valores posibles, consulte a continuación.
tipo de operación	string	Tipo de operación que generó el evento. Este campo está presente cuando `eventTypeName` es `DATA_EXPLORER` o `DATA_EXPLORER_CRUD`.
Puerto	entero	Puerto del host asociado con este evento.
publicKey	string	Clave pública asociada con la clave API que activó este evento. Si este campo está presente en la respuesta, Ops Manager no devuelve el campo `username`.
dirección remota	string	Dirección IP asociada con el usuario de Ops Manager (userId) que disparó el evento.
nombreConjuntoRéplica	string	Nombre del conjunto de réplicas.
nombrefragmento	string	Nombre del fragmento asociado con el evento.
targetPublicKey	string	Clave pública de la clave API a la que se dirige el evento.
Nombre de usuario objetivo	string	Nombre de usuario del usuario Ops Manager al que se dirige este evento.
ID de equipo	string	Identificador único del equipo de Ops Manager asociado con este evento.
ID de usuario	string	Identificador único del usuario de Ops Manager que activó este evento. Si este campo está presente en la respuesta, Ops Manager no devuelve el campo `apiKeyId`.
Nombre de usuario	string	Nombre de usuario del usuario Ops Manager que activó este evento. Si este campo está presente en la respuesta, Ops Manager no devuelve el campo `publicKey`.
Entrada de lista de acceso	string	Entrada de la lista de acceso de la clave API a la que se dirige el evento.

Ejemplo de solicitud

curl --user "{publicKey}:{privateKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/globalEvents?pretty=true"

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   "alertConfigId": "{alertConfigId}",
3   "alertId": "{alertId}",
4   "clusterId": "{clusterId}",
5   "clusterName": "Test Cluster",
6   "created": "2018-06-11T12:34:56Z",
7   "currentValue": {
8     "number": 50,
9     "units": "RAW"
10   },
11   "eventTypeName": "OUTSIDE_METRIC_THRESHOLD",
12   "groupId": "{groupId}",
13   "hostId": "{hostId}",
14   "hostname": "db.example.com",
15   "id": "{globalAlertId}",
16   "isGlobalAdmin": false,
17   "maintenanceWindowId": "{maintenanceWindowId}",
18   "metricName": "OPCOUNTER_CMD",
19   "orgId": "{orgId}",
20   "port": 27017,
21   "remoteAddress": "192.168.1.1",
22   "replicaSetName": "rs1",
23   "shardName": "sh1",
24   "userId": "{userId}",
25   "username": "john.doe@example.com",
26   "targetUsername": "jane.doe@example.com",
27   "teamId": "{teamId}"
28 }

Volver

Eventos globales

Consigue uno

1	{
2	"alertConfigId": "{alertConfigId}",
3	"alertId": "{alertId}",
4	"clusterId": "{clusterId}",
5	"clusterName": "Test Cluster",
6	"created": "2018-06-11T12:34:56Z",
7	"currentValue": {
8	"number": 50,
9	"units": "RAW"
10	},
11	"eventTypeName": "OUTSIDE_METRIC_THRESHOLD",
12	"groupId": "{groupId}",
13	"hostId": "{hostId}",
14	"hostname": "db.example.com",
15	"id": "{globalAlertId}",
16	"isGlobalAdmin": false,
17	"maintenanceWindowId": "{maintenanceWindowId}",
18	"metricName": "OPCOUNTER_CMD",
19	"orgId": "{orgId}",
20	"port": 27017,
21	"remoteAddress": "192.168.1.1",
22	"replicaSetName": "rs1",
23	"shardName": "sh1",
24	"userId": "{userId}",
25	"username": "john.doe@example.com",
26	"targetUsername": "jane.doe@example.com",
27	"teamId": "{teamId}"
28	}

Roles necesarios

Solicitud

Parámetros de la ruta de solicitud

Parámetros de consulta de solicitud

Parámetros de consulta únicos

Parámetros de consulta comunes

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