Docs Menu
Docs Home
/ /

Obtener todos los eventos del proyecto

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

URL base: https://cloud.mongodb.com/api/public/v1.0

GET /groups/{groupId}/events
Nombre
Tipo
Descripción

ID de grupo

string

Identificador único del proyecto asociado al evento deseado.

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

Nombre
Tipo
Descripción
predeterminado

tipo de evento

string

Devuelve sólo eventos de los tipos especificados.

Para revisar los tipos de eventos que generan alertas, consulte Tipos de alerta.

incluirRaw

booleano

Especifica si se debe incluir el documento raw en la salida. El documento raw contiene información adicional sobre el evento.

IMPORTANTE: Los valores del raw documento varían según el recurso al que se aplica el evento. Utilice este campo con precaución, ya que su estructura puede variar según el tipo de recurso.

false

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.

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 endpoints que devuelven una lista de resultados, el objeto results es un sobre. Cloud Manager añade el campo status al cuerpo de la respuesta.

Ninguno

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

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.

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, Cloud Manager no devuelve el campo userId.

clusterId

string

ID 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 relevantes para el valor.

Por ejemplo, una métrica que mide el consumo de memoria tendría una medida de byte, mientras que una métrica que mide el tiempo tendría una unidad de tiempo.

Los valores aceptados son:

  • RAW

  • BITS

  • BYTES

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • GIGABITS

  • GIGABYTES

  • TERABYTES

  • PETABYTES

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

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.

ID de grupo

string

ID del proyecto en el que ocurrió este evento.

ID de host

string

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

invoiceId

string

Identificador único de la factura asociada a este evento.

esGlobalAdmin

booleano

Bandera que indica si el usuario que activó este evento es un empleado de MongoDB.

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.

ID de pago

string

Identificador único del pago de factura asociado a este evento.

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, Cloud Manager no devuelve el campo username.

crudo

Documento

Metainformación adicional sobre el evento. Este campo solo aparece cuando el parámetro de consulta includeRaw es true.

IMPORTANTE: Los valores del raw documento varían según el recurso al que se aplica el evento. Utilice este campo con precaución, ya que su estructura puede variar según el tipo de recurso.

dirección remota

string

Dirección IP asociada con el usuario de Cloud Manager (userId) que activó el evento.

nombreConjuntoRéplica

string

Nombre del conjunto de réplicas.

nombrefragmento

string

El 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 de Cloud Manager al que se dirige este evento.

ID de equipo

string

Identificador único del equipo de Cloud Manager asociado a este evento.

ID de usuario

string

Identificador único del usuario de Cloud Manager que activó este evento.

Si este campo está presente en la respuesta, Cloud Manager no devuelve el campo apiKeyId.

Nombre de usuario

string

Nombre de usuario del usuario de Cloud Manager que activó este evento.

Si este campo está presente en la respuesta, Cloud 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.

curl --user "{publicKey}:{privateKey}" --digest \
--header "Accept: application/json" \
--include \
--request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{groupId}/events?pretty=true"
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}
1{
2 "links" : [ {
3 "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{groupId}/events?pretty=true&pageNum=1&itemsPerPage=100",
4 "rel" : "self"
5 }, {
6 "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{groupId}/events?pretty=true&itemsPerPage=100&pageNum=2",
7 "rel" : "next"
8 } ],
9 "results" : [ {
10 "created" : "2020-07-13T21:28:37Z",
11 "diffs" : [ {
12 "id" : "admin@admin",
13 "name" : null,
14 "params" : [ {
15 "display" : "Added Privilege",
16 "new" : "config.system.sessions: moveChunk",
17 "old" : null,
18 "param" : "config.system.sessions: moveChunk"
19 }, {
20 "display" : "Added Privilege",
21 "new" : "config.system.sessions: splitChunk",
22 "old" : null,
23 "param" : "config.system.sessions: splitChunk"
24 }, {
25 "display" : "Added Privilege",
26 "new" : "config.system.sessions: splitVector",
27 "old" : null,
28 "param" : "config.system.sessions: splitVector"
29 } ],
30 "priviileges" : [ {
31 "actions" : [ "moveChunk" ],
32 "resource" : {
33 "collection" : "system.sessions",
34 "db" : "config"
35 }
36 }, {
37 "actions" : [ "moveChunk" ],
38 "resource" : {
39 "collection" : "",
40 "db" : ""
41 }
42 }, {
43 "actions" : [ "enableSharding" ],
44 "resource" : {
45 "cluster" : true
46 }
47 }, {
48 "actions" : [ "cleanupOrphaned" ],
49 "resource" : {
50 "cluster" : true
51 }
52 }, {
53 "actions" : [ "flushRouterConfig" ],
54 "resource" : {
55 "cluster" : true
56 }
57 }, {
58 "actions" : [ "splitChunk" ],
59 "resource" : {
60 "collection" : "system.sessions",
61 "db" : "config"
62 }
63 }, {
64 "actions" : [ "splitChunk" ],
65 "resource" : {
66 "collection" : "",
67 "db" : ""
68 }
69 }, {
70 "actions" : [ "splitVector" ],
71 "resource" : {
72 "collection" : "system.sessions",
73 "db" : "config"
74 }
75 }, {
76 "actions" : [ "viewRole" ],
77 "resource" : {
78 "collection" : "",
79 "db" : ""
80 }
81 } ],
82 "roles" : [ {
83 "db" : "admin",
84 "role" : "readWriteAnyDatabase"
85 }, {
86 "db" : "admin",
87 "role" : "dbAdminAnyDatabase"
88 }, {
89 "db" : "admin",
90 "role" : "enableSharding"
91 }, {
92 "db" : "admin",
93 "role" : "backup"
94 }, {
95 "db" : "admin",
96 "role" : "clusterMonitor"
97 } ],
98 "status" : "MODIFIED",
99 "type" : "ROLES"
100 }, {
101 "id" : "sample-dataset-load@admin",
102 "name" : null,
103 "params" : [ ],
104 "priviileges" : null,
105 "roles" : [ {
106 "db" : "admin",
107 "role" : "readWriteAnyDatabase"
108 } ],
109 "status" : "NEW",
110 "type" : "USERS"
111 }, {
112 "id" : "10.16.0.6482-1",
113 "name" : null,
114 "params" : [ {
115 "display" : "Version",
116 "new" : "10.16.0.6482-1",
117 "old" : "10.12.0.6179-1",
118 "param" : "version"
119 } ],
120 "status" : "MODIFIED",
121 "type" : "AUTOMATION_AGENT"
122 } ],
123 "eventTypeName" : "AUTOMATION_CONFIG_PUBLISHED_AUDIT",
124 "groupId" : "{groupId}",
125 "id" : "{eventId}",
126 "isGlobalAdmin" : false,
127 "links" : [ {
128 "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{groupId}/events/{eventId}",
129 "rel" : "self"
130 } ]
131 }],
132 "totalCount" : 1
133}

Volver

Consigue uno (Organización)

En esta página