Roles necesarios
Tu clave de API debe tener la Project Read Only rol para llamar a este recurso exitosamente.
Solicitud
URL base: https://cloud.mongodb.com/api/public/v1.0
GET /groups/{groupId}/events/{eventId}
Parámetros de la ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
ID del grupo | string | Identificador único del proyecto asociado con el evento deseado. |
eventId | string | Identificador único del evento deseado. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Parámetro query | Tipo | Descripción | predeterminado |
|---|---|---|---|
bonito | booleano | Muestra la respuesta en un prettyprint formato. |
|
envelope | booleano | Especifica si se debe envolver la respuesta en un envelope. |
|
incluir crudo | booleano | Especifica si se debe incluir el documento IMPORTANTE: Los valores en el |
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
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, Cloud Manager no devuelve el campo |
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 |
creado | string | Marca de tiempo en ISO 8601 formato de fecha y hora 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:
|
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. |
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 |
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 |
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 |
crudo | Documento | Información adicional sobre el evento. Este campo solo aparece cuando el parámetro de query IMPORTANTE: Los valores en el |
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 |
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 |
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/groups/{groupId}/events/{eventId}?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 "created" : "2020-07-13T21:28:37Z", 3 "diffs" : [ { 4 "id" : "admin@admin", 5 "name" : null, 6 "params" : [ { 7 "display" : "Added Privilege", 8 "new" : "config.system.sessions: moveChunk", 9 "old" : null, 10 "param" : "config.system.sessions: moveChunk" 11 }, { 12 "display" : "Added Privilege", 13 "new" : "config.system.sessions: splitChunk", 14 "old" : null, 15 "param" : "config.system.sessions: splitChunk" 16 }, { 17 "display" : "Added Privilege", 18 "new" : "config.system.sessions: splitVector", 19 "old" : null, 20 "param" : "config.system.sessions: splitVector" 21 } ], 22 "priviileges" : [ { 23 "actions" : [ "moveChunk" ], 24 "resource" : { 25 "collection" : "system.sessions", 26 "db" : "config" 27 } 28 }, { 29 "actions" : [ "moveChunk" ], 30 "resource" : { 31 "collection" : "", 32 "db" : "" 33 } 34 }, { 35 "actions" : [ "enableSharding" ], 36 "resource" : { 37 "cluster" : true 38 } 39 }, { 40 "actions" : [ "cleanupOrphaned" ], 41 "resource" : { 42 "cluster" : true 43 } 44 }, { 45 "actions" : [ "flushRouterConfig" ], 46 "resource" : { 47 "cluster" : true 48 } 49 }, { 50 "actions" : [ "splitChunk" ], 51 "resource" : { 52 "collection" : "system.sessions", 53 "db" : "config" 54 } 55 }, { 56 "actions" : [ "splitChunk" ], 57 "resource" : { 58 "collection" : "", 59 "db" : "" 60 } 61 }, { 62 "actions" : [ "splitVector" ], 63 "resource" : { 64 "collection" : "system.sessions", 65 "db" : "config" 66 } 67 }, { 68 "actions" : [ "viewRole" ], 69 "resource" : { 70 "collection" : "", 71 "db" : "" 72 } 73 } ], 74 "roles" : [ { 75 "db" : "admin", 76 "role" : "readWriteAnyDatabase" 77 }, { 78 "db" : "admin", 79 "role" : "dbAdminAnyDatabase" 80 }, { 81 "db" : "admin", 82 "role" : "enableSharding" 83 }, { 84 "db" : "admin", 85 "role" : "backup" 86 }, { 87 "db" : "admin", 88 "role" : "clusterMonitor" 89 } ], 90 "status" : "MODIFIED", 91 "type" : "ROLES" 92 } 93 }