Nota
Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es lo mismo que tu ID del grupo. Para los grupos existentes, su identificador de grupo/proyecto sigue siendo el mismo. Esta página utiliza el término más familiar "grupo" al referirse a descripciones. El endpoint permanece 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 ruta de solicitud
Todos los parámetros de 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 alertas. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
Num. de pág. | Número | Opcional | Entero basado en uno que devuelve una subsección de resultados. |
|
elementosPorPágina | Número | Opcional | Número de elementos a devolver por página, hasta un máximo de 500. |
|
bonito | booleano | Opcional | Bandera que indica si el cuerpo de la respuesta debe estar en una pretty-print formato. |
|
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediarlo, establezca Para los endpoints que devuelven una lista de resultados, el objeto |
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
Documento de respuesta
El documento de respuesta JSON incluye un arreglo de result objetos, un arreglo de link objetos y una cantidad del número total de result objetos recuperados.
Nombre | Tipo | Descripción |
|---|---|---|
| arreglo | El arreglo incluye un objeto para cada elemento detallado en el
Sección |
| 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. |
| 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 una configuración de alerta.
Nota
Los detalles de alerta varían. Una alerta solo puede incluir un subconjunto de estos elementos.
Nombre | Tipo | Descripción |
|---|---|---|
reconocidoHasta | string | Marca de tiempo en ISO 8601 formato de fecha y hora en UTC cuando la alerta ha sido reconocida. Se completa si la alerta ha sido reconocida. |
acknowledgingUsername | string | Nombre de usuario del usuario que reconoció la alerta. Se completa si la alerta ha sido reconocida. |
acknowledgementComment | string | El usuario que reconoció la alerta se marchó. Se informa si la alerta ha sido reconocida. |
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 ha rellenado para las alertas |
Nombre del clúster | string | Nombra el clúster al que se aplica esta alerta. Se llena para las alertas |
creado | string | Referencia temporal en ISO 8601 fecha y formato de 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 |
currentValue.number | Número | Valor de la métrica. |
currentValue.units | string | Unidades para el valor. Depende del tipo de métrica. Por ejemplo, una métrica que mida el consumo de memoria tendría una medición en bytes, mientras que una métrica que mida el tiempo tendría una unidad de tiempo. Los valores aceptados son:
|
eventTypeName | 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 revisar la lista completa de eventos que generan alertas y sus descripciones, consulta Tipos de Alertas. Para obtener una lista completa de los eventos incluidos en el registro de auditoría de Ops Manager, consulta Eventos de auditoría. |
ID del grupo | string | Identificador único del proyecto para el cual se abrió esta alerta. |
hostId | string | Identificador único del host al que pertenece la métrica. Se llena para las alertas |
hostnameAndPort | string | Nombre de host y puerto de cada host al que se aplica la alerta. Se ha rellenado para las alertas |
ID | string | Identificador único para la alerta. |
Última notificación | string | Marca de tiempo en ISO 8601 Formato de fecha y hora en UTC cuando se envió la última notificación de esta alerta. Se llena si se han enviado notificaciones. |
metricName | string | Nombre de la medida cuyo valor superó el umbral. Se rellena si Para los valores aceptados, consulta Tipos de medición para alertas en esta página. |
replicaSetName | string | Nombre del set de réplicas. Se completaron para |
resuelto | string | Timestamp en ISO 8601 formato de fecha y hora en UTC cuando se cerró la alerta. Se completará si |
nombreTipoFuente | string | Para alertas
|
Estado | string | Estado actual de la alerta. Los valores aceptados son:
|
typeName | string | Este campo está obsoleto y será ignorado. |
actualizado | string | Marca de tiempo en ISO 8601 en formato de fecha y hora en UTC cuando la alerta se actualizó por última vez. |
Solicitud de ejemplo
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"
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
{ "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 }