Nota
Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} Es el mismo que el ID de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. Esta página utiliza el término "grupo" para las descripciones. El punto final se mantiene como se indica en el documento.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}/alerts
Parámetros de la ruta de solicitud
Todos los parámetros de la ruta de solicitud son obligatorios.
Parameter | Tipo | Descripción |
|---|---|---|
PROJECT-ID | string | Identificador único para este proyecto. |
ALERT-CONFIG-ID | string | Identificador único para esta configuración de alerta. |
Parámetros de consulta de solicitud
Los siguientes parámetros de consulta son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
número de página | Número | Opcional | Entero basado en uno que devuelve una subsección de resultados. |
|
artículos por página | Número | Opcional | Número de artículos a devolver por página, hasta un máximo de 500. |
|
bonita | booleano | Opcional | Bandera que indica si el cuerpo de la respuesta debe estar en un impresión bonita formato. |
|
envolvente | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure Para los puntos finales que devuelven una lista de resultados, el objeto |
|
Parámetros del cuerpo de la solicitud
Este punto final no utiliza parámetros del cuerpo de la 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 |
|---|---|---|
| arreglo | La matriz incluye un objeto para cada elemento detallado en el
Sección |
| 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. |
| 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. |
results Documento incrustado
Cada resultado es una configuración de alerta.
Nota
Los detalles de las alertas varían. Una alerta puede incluir solo un subconjunto de estos elementos.
Nombre | Tipo | Descripción |
|---|---|---|
reconocidoHasta | string | Marca de tiempo en formato ISO 8601 de fecha y hora UTC en la que se confirmó la alerta. Se rellena si se confirmó la alerta. |
reconociendoNombreDeUsuario | string | Nombre de usuario del usuario que confirmó la alerta. Se completa si se confirmó la alerta. |
reconocimientoComentario | string | Comentario del usuario que reconoció la alerta. Se completa si se reconoció la alerta. |
alertConfigId | string | Identificador único de la configuración de alerta que activó esta alerta. |
clusterId | string | Identificador único del clúster al que se aplica esta alerta. Se completa para las alertas |
nombre del clúster | string | Nombre el clúster al que se aplica esta alerta. Se completa para las alertas |
creado | string | Marca de tiempo en formato ISO 8601 fecha y hora en UTC cuando se abrió la alerta. |
valorActual | Objeto | Valor actual de la métrica que activó la alerta. Poblado para las alertas de |
valorActual.Número | Número | Valor de la métrica. |
valorActual.unidades | string | Unidades para el valor. Depende del tipo de métrica. Por ejemplo, una métrica que mide el consumo de memoria se mediría en bytes, mientras que una métrica que mide el tiempo se mediría en unidades de tiempo. Los valores aceptados son:
|
nombreDeTipoDeEvento | string | Nombre del evento que activó la alerta. Los valores incluyen: Agente Configuración de automatización Backup Conector de BI Clúster Explorador de datos accedido Host Organización Proyecto Set de réplicas Equipo Usuario Para consultar la lista completa de eventos que generan alertas y sus descripciones, consulte Tipos de alerta. Para obtener una lista completa de los eventos incluidos en el registro de auditoría de Ops Manager, consulte Eventos de auditoría. |
ID de grupo | string | Identificador único del proyecto para el que se abrió esta alerta. |
ID de host | string | Identificador único del host al que pertenece la métrica. Se completa para las alertas |
hostnameAndPort | string | Nombre de host y puerto de cada host al que se aplica la alerta. Se completa para las alertas |
ID. | string | Identificador único para la alerta. |
última notificación | string | Marca de tiempo en formato ISO 8601 de fecha y hora UTC del último envío de notificaciones para esta alerta. Se rellena si se enviaron notificaciones. |
nombremétrico | string | Nombre de la medición cuyo valor superó el umbral. Se completa si es Para los valores aceptados, consulta Tipos de medición para alertas en esta página. |
nombreConjuntoRéplica | string | Nombre del conjunto de réplicas. Se completa para las alertas |
resuelto | string | Marca de tiempo en formato ISO,8601 fecha y hora UTC del cierre de la alerta. Se completa si |
nombreDeTipoDeFuente | string | Para las alertas
|
Estado | string | Estado actual de la alerta. Los valores aceptados son:
|
tipoNombre | string | Este campo está obsoleto y será ignorado. |
actualizado | string | Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando se actualizó la alerta por última vez. |
Ejemplo de solicitud
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}/alerts"
Ejemplo de respuesta
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}
Cuerpo de respuesta
{ "links" : [], "results" : [ { "acknowledgedUntil" : "2014-05-01T14:00:00Z", "alertConfigId":"{ALERT-CONFIG-ID}", "created" : "2014-04-22T15:57:13.562Z", "currentValue" : { "number" : 0.0, "units" : "RAW" }, "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD", "groupId" : "{PROJECT-ID}", "id" : "53569159300495c7702ee3a3", "lastNotified" : "2014-04-22T15:57:24.126Z", "links" : [], "metricName" : "ASSERT_REGULAR", "status" : "OPEN", "updated" : "2014-04-22T20:14:11.388Z" }, { "alertConfigId":"{ALERT-CONFIG-ID}", "created" : "2014-04-22T19:59:10.657Z", "currentValue" : { "number" : 0.0, "units" : "RAW" }, "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD", "groupId" : "{PROJECT-ID}", "id" : "5356ca0e300495c770333340", "lastNotified" : "2014-04-22T20:14:19.313Z", "links" : [], "metricName" : "ASSERT_REGULAR", "status" : "OPEN", "updated" : "2014-04-22T20:14:11.388Z" } ], "totalCount" : 2 }