/ /

/ /

Gerente de Operaciones

Obtener un evento organizativo

Roles necesarios

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

Solicitud

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /orgs/{orgId}/events/{eventId}

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
orgId	string	Identificador único de la organización asociada 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 una pretty-print formato.	`false`
envelope	booleano	Especifica si se debe envolver la respuesta en un envelope.	`false`
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`

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 `alertId`.
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 `userId`.
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 `eventTypeName` es `DATA_EXPLORER` o `DATA_EXPLORER_CRUD`.
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: `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. 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 `Global Monitoring Administrator`.
enlaces	objeto arreglo	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 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`.
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 `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 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 `apiKeyId`.
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 `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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{orgId}/events/{eventId}?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   "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 }

Volver

Obtener todo (Organización)

Get All (Proyecto)

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	}