Get One Project Event
On this page
Required Roles
Your API Key must have the Project Read Only
role to
successfully call this resource.
Request
Base URL: https://cloud.mongodb.com/api/public/v1.0
GET /groups/{groupId}/events/{eventId}
Request Path Parameters
Name | Type | Description |
---|---|---|
groupId | string | Unique identifier of the project associated with the
desired event. |
eventId | string | Unique identifier of the desired event. |
Request Query Parameters
The following query parameters are optional:
Query Parameter | Type | Description | Default |
---|---|---|---|
pretty | boolean | Displays response in a prettyprint format. | false |
envelope | boolean | Specifies whether or not to wrap the response in an envelope. | false |
includeRaw | boolean | Specifies whether to include the IMPORTANT: The values in the | false |
Request Body Parameters
This endpoint doesn't use HTTP request body parameters.
Response
Name | Type | Description |
---|---|---|
alertId | string | Unique identifier for the alert associated with this event. |
alertConfigId | string | Unique identifier for the alert configuration associated with
the alertId . |
apiKeyId | string | Unique identifier for the API Key that triggered this event. If this field is present in the response, Cloud Manager does not return
the |
clusterId | string | ID of the cluster to which this event applies. |
clusterName | string | Name of the cluster to which this event applies. |
collection | string | Name of the collection on which the event occurred. This field
can be present when the eventTypeName is either
DATA_EXPLORER or DATA_EXPLORER_CRUD . |
created | string | Timestamp in ISO 8601 date and time format in UTC when this event was triggered. |
currentValue | object | Current value of the metric that triggered this event. |
currentValue .number | number | Value of the metric. |
currentValue .units | string | Relevant units for the value. For example, a metric that measures memory consumption would have a byte measurement, while a metric that measures time would have a time unit. Accepted values are:
|
database | string | Name of the database on which the event occurred. This field
can be present when the eventTypeName is either
DATA_EXPLORER or DATA_EXPLORER_CRUD . |
eventTypeName | string | Name of the circumstance that triggered this event. To review the types of events that generate alerts, see Alert Types. |
groupId | string | ID of the project in which this event occurred. |
hostId | string | ID of the host on which this event occurred. |
hostname | string | Hostname, FQDN, IPv4 address, or IPv6 address of the host
on which this event occurred. |
id | string | Unique identifier for this event. |
invoiceId | string | Unique identifier of the invoice associated with this event. |
isGlobalAdmin | boolean | Flag indicating whether the user who triggered this event is a
MongoDB employee. |
links | object array | One or more links to sub-resources and/or related resources. All
|
metricName | string | Name of the measurement whose value went outside the threshold. For possible values, see below. |
opType | string | Type of operation that generated the event. This field is
present when the eventTypeName is either DATA_EXPLORER
or DATA_EXPLORER_CRUD . |
paymentId | string | Unique identifier of the invoice payment associated with this
event. |
port | integer | Port of the host associated with this event. |
publicKey | string | Public key associated with the API Key that triggered this event. If this field is present in the response, Cloud Manager does not return
the |
raw | document | Additional meta information about the event. This field only
appears when the IMPORTANT: The values in the |
remoteAddress | string | IP address associated with the Cloud Manager user (userId) who
triggered the event. |
replicaSetName | string | Name of the replica set. |
shardName | string | The name of the shard associated with the event. |
targetPublicKey | string | Public key of the API Key targeted by the event. |
targetUsername | string | Username for the Cloud Manager user targeted by this event. |
teamId | string | Unique identifier for the Cloud Manager team associated with this event. |
userId | string | Unique identifier for the Cloud Manager user who triggered this event. If this field is present in the response, Cloud Manager does not
return the |
username | string | Username for the Cloud Manager user who triggered this event. If this field is present in the response, Cloud Manager does not return
|
accessListEntry | string | Access list entry of the API Key targeted by the event. |
Example Request
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"
Example Response
Response Header
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}
Response Body
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 }