/ /

/ /

Obtener todos los eventos de la organización

Cloud Manager dejará de admitir la Automatización, la Copia de seguridad y la Supervisión para MongoDB 3.6 y 4.0 después del 30de agosto de 2024. Por favor actualiza tu implementación de MongoDB o migra a Atlas.

Roles necesarios

Tu clave de API debe tener la Organization Member rol para llamar a este recurso exitosamente.

Solicitud

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

GET /orgs/{orgId}/events

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
eventType	string	Devuelve solo eventos de los tipos especificados. Para revisar los tipos de eventos que generan alertas, consulta Tipos de Alertas.
incluir crudo	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 en el `raw` documento varían en función del recurso al que se aplique el evento. Utiliza este campo con precaución, ya que su estructura podría 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.

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

1

elementosPorPágina

entero

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

100

bonito

booleano

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

false

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 "envelope" : true en la consulta.

Para los endpoints que devuelven un resultado, el cuerpo de respuesta incluye:

Nombre	Descripción
`status`	Código de respuesta HTTP
`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

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
`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 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 `alertId`.
apiKeyId	string	Identificador único para la llave 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 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 relevantes para el valor. Por ejemplo, una métrica que mide el consumo de memoria tendría una medida en bytes, 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 activó este evento. Para revisar los tipos de eventos que generan alertas, consulta Tipos de Alertas.
ID del grupo	string	ID del proyecto en el que ocurrió este evento.
hostId	string	ID 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.
invoiceId	string	Identificador único de la factura asociada a este evento.
esAdministradorGlobal	booleano	Bandera que indica si el usuario que activó este evento es un empleado de MongoDB.
enlaces	objeto arreglo	Uno o más enlaces a subrecursos y/o recursos relacionados. Todos los `links` arreglos en las respuestas incluyen al menos un enlace llamado `self`. Las relaciones entre URLs se explican en la Especificación de Enlaces Web.
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 `eventTypeName` es `DATA_EXPLORER` o `DATA_EXPLORER_CRUD`.
idPago	string	Identificador único del pago de factura asociado a este evento.
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, Cloud Manager no devuelve el campo `username`.
crudo	Documento	Información adicional sobre el evento. Este campo solo aparece cuando el parámetro de query `includeRaw` es `true`. IMPORTANTE: Los valores en el `raw` documento varían en función del recurso al que se aplique el evento. Utiliza este campo con precaución, ya que su estructura podría variar según el tipo de recurso.
direcciónRemota	string	Dirección IP asociada con el usuario de Cloud Manager (userId) que activó el evento.
replicaSetName	string	Nombre del set de réplicas.
shardName	string	El 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 para el 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 para el 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 desencadenó este evento. Si este campo está presente en la respuesta, Cloud Manager no devuelve el campo `publicKey`.
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://cloud.mongodb.com/api/public/v1.0/orgs/{orgId}/events?pretty=true"

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   "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   "invoiceId": "{invoiceId}",
17   "isGlobalAdmin": false,
18   "maintenanceWindowId": "{maintenanceWindowId}",
19   "metricName": "OPCOUNTER_CMD",
20   "orgId": "{orgId}",
21   "paymentId": "{paymentId}",
22   "port": 27017,
23   "remoteAddress": "192.168.1.1",
24   "replicaSetName": "rs1",
25   "shardName": "sh1",
26   "userId": "{userId}",
27   "username": "john.doe@example.com",
28   "targetUsername": "jane.doe@example.com",
29   "teamId": "{teamId}"
30 }

Volver

Eventos

Obtén uno (organización)

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	"invoiceId": "{invoiceId}",
17	"isGlobalAdmin": false,
18	"maintenanceWindowId": "{maintenanceWindowId}",
19	"metricName": "OPCOUNTER_CMD",
20	"orgId": "{orgId}",
21	"paymentId": "{paymentId}",
22	"port": 27017,
23	"remoteAddress": "192.168.1.1",
24	"replicaSetName": "rs1",
25	"shardName": "sh1",
26	"userId": "{userId}",
27	"username": "john.doe@example.com",
28	"targetUsername": "jane.doe@example.com",
29	"teamId": "{teamId}"
30	}

Roles necesarios

Solicitud

Parámetros de la ruta de solicitud

Parámetros de Solicitud Query

Parámetros únicos de query

Parámetros de consulta comunes

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