Roles necesarios
Tu clave de 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 endpoint no utiliza parámetros de ruta de solicitud HTTP.
Parámetros de Solicitud Query
Parámetros únicos de query
Este endpoint acepta los siguientes parámetros de query para filtrar eventos devueltos:
Nombre | Tipo | Descripción | predeterminado |
|---|---|---|---|
minDate | string | Devuelve solo los eventos cuya fecha de creación es mayor o igual a la Timestamp 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. | |
eventType | string | Devuelve solo eventos de los tipos especificados. Los valores aceptados incluyen: 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. |
Parámetros de consulta comunes
Este endpoint también acepta los parámetros de query comunes a todos los endpoints que devuelven listas de valores:
Nombre | Tipo | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|
Num. de pág. | entero | Número de página (basado en índice a partir de 1). |
| ||||||
elementosPorPágina | entero | Número de elementos a devolver por página, hasta un máximo de 500. |
| ||||||
bonito | booleano | Indica si el cuerpo de la respuesta debe estar en un formato prettyprint. |
| ||||||
envelope | booleano | Indica si se debe o no envolver 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 Para los endpoints que devuelven un resultado, el cuerpo de respuesta incluye:
Para los endpoints que devuelven una lista de resultados, el objeto | Ninguno |
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de 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 |
|---|---|---|
| arreglo | El arreglo incluye un objeto para cada elemento detallado en la sección del |
| 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. |
| 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 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 alertas asociada con el |
apiKeyId | string | Identificador único para la llave API que activó este evento. Si este campo está presente en la respuesta, Ops Manager no devuelve el campo |
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 |
creado | string | Marca de tiempo en ISO 8601 formato 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 Los valores aceptados son:
Por ejemplo, una métrica que mide el consumo de memoria puede usar |
database | string | Nombre de la base de datos donde ocurrió el evento. Este campo puede estar presente cuando |
nombreDeTipoDeEvento | string | Nombre de la circunstancia que activó este evento. 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. |
ID del grupo | string | Identificador único del proyecto en el que ocurrió este evento. |
hostId | string | Identificador único del host en el que ocurrió este evento. |
Nombre del host | string | Nombre del host, FQDN, dirección IPv4 o dirección IPv6 del host en el que ocurrió este evento. |
ID | string | Identificador único para este evento. |
esAdministradorGlobal | booleano | Indicador que señala si el usuario que activó este evento tiene el rol de |
enlaces | objeto arreglo | Uno o más enlaces a subrecursos o recursos relacionados. Todas las |
nombremétrico | string | Nombre de la medición cuyo valor excedió el umbral. Para los posibles valores, véase a continuación. |
tipo de operación | string | Tipo de operación que generó el evento. Este campo está presente cuando |
Puerto | entero | Puerto del host asociado a este evento. |
publicKey | string | Clave pública asociada a la clave API que activó este evento. Si este campo está presente en la respuesta, Ops Manager no devuelve el campo |
direcciónRemota | string | Dirección IP asociada con el usuario de Ops Manager (userId) que disparó el evento. |
replicaSetName | string | Nombre del set de réplicas. |
shardName | string | Nombre de la partición asociado con el evento. |
targetPublicKey | string | Clave pública de la clave API a la que se dirige el evento. |
targetUsername | 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 |
Nombre de usuario | string | Nombre de usuario del usuario de Ops Manager que activó este evento. Si este campo está presente en la respuesta, Ops Manager no devuelve el campo |
accessListEntry | string | Entrada de la lista de acceso de la clave API a la que apunta el evento. |
Solicitud de ejemplo
curl --user "{publicKey}:{privateKey}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/globalEvents?pretty=true"
Respuesta de ejemplo
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
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 "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 }