Se puede reconocer una alerta hasta la fecha y hora que se especifique. También puede eliminar el reconocimiento de una alerta especificando una fecha y hora pasadas.
Roles necesarios
Puede llamar a este endpoint con éxito con cualquiera de los siguientes roles asignados:
Solicitud
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PATCH /globalAlerts/{ALERT-ID}Parámetros de ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único de la alerta que desea reconocer. |
Parámetros de Solicitud Query
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que muestra si el cuerpo de la respuesta está en formato pretty-print. |
|
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Body Parameter | Tipo | Necesidad | Descripción |
|---|---|---|---|
| string | Requerido | Sello de tiempo en ISO 8601 formato de fecha y hora en UTC mediante el cual reconoce esta alerta. Una vez transcurrido este tiempo, MongoDB Ops Manager revierte la alerta a no reconocida. Para evitar que la alerta se retome pronto, configura la fecha y la hora a un punto lejano en el futuro. Para desconfirmar una alerta, se debe especificar una hora y fecha pasadas. |
| string | Opcional | Comentario que describe el reconocimiento de la alerta. |
Respuesta
Nombre | Tipo | Descripción |
|---|---|---|
| string | Sello de tiempo en ISO 8601 formato de fecha y hora en UTC mediante el cual se ha confirmado la alerta. Ops Manager muestra este campo si un usuario reconoció esta alerta. |
| string | Comentario que el usuario que reconoció esta alerta dejó. Ops Manager presenta este campo si un usuario reconoció esta alerta. |
| string | Nombre de usuario de Ops Manager del usuario que acusó recibo de la alerta. Ops Manager presenta este campo si un usuario reconoce esta alerta. |
| string | Identificador único de la configuración global de alertas que activó esta alerta. |
| string | Identificador único del clúster al que se aplica esta alerta. Ops Manager devuelve este campo para alertas globales en las siguientes categorÃas: |
| string | Asigna un nombre al clúster al que se aplica esta alerta. Ops Manager devuelve este campo para alertas globales en las categorÃas de: |
| string | Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se creó la alerta. |
| Objeto | Valor actual de la métrica que activó la alerta. Ops Manager devuelve este campo para alertas globales en la categorÃa de host. |
| Número | Valor actual de la métrica. |
| string | Unidades para Los valores aceptados son:
Por ejemplo, una métrica que mide el consumo de memoria puede utilizar |
| string | Nombre del evento que activó la alerta. 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. |
| string | Identificador único del proyecto para el cual se abrió esta alerta. |
| string | Identificador único del host al que corresponde la métrica. Ops Manager devuelve este campo para alertas globales en las siguientes categorÃas: |
| string | Nombre de host y puerto de cada host al que se aplica la alerta. El nombre de host puede ser solo un nombre de host, un FQDN, una dirección IPv4 o una dirección IPv6. MongoDB Ops Manager devuelve este campo para alertas globales en las categorÃas de: |
| string | Identificador único de la alerta. |
| string | Marca de tiempo en el formato de fecha y hora ISO 8601 en UTC cuando se envió la última notificación para esta alerta. Ops Manager muestra esto si Ops Manager envió notificaciones. |
| string | Nombre de la medida cuyo valor superó el umbral. Ops Manager devuelve este campo si Para posibles valores, consulta Tipos de mediciones para alertas globales. |
| string | Nombre del set de réplicas. Ops Manager devuelve este campo para alertas globales en las categorÃas de: |
| string | Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se cerró la alerta. MongoDB Ops Manager devuelve este campo para las alertas globales cuando |
| string | Tipo de host que se está respaldando. Ops Manager devuelve este campo para alertas globales en la categorÃa de copia de seguridad. Los valores posibles que se pueden devolver incluyen:
|
| string | Estado actual de la alerta. Los valores posibles que se pueden devolver incluyen:
|
| Arreglo de cadenas | Etiquetas asociadas a esta alerta. |
| string | Este campo está obsoleto y será ignorado. |
| string | Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se actualizó por última vez esta alerta. |
Solicitud de ejemplo
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlerts/{ALERT-ID}" \ --data '{ "acknowledgedUntil":"2020-04-10T20:21:31Z", "acknowledgementComment":"test" }'Respuesta de ejemplo
Encabezado de respuesta
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 201 CreatedVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Respuesta del cuerpo
{ "acknowledgedUntil": "2020-04-10T20:20:38Z", "acknowledgementComment": "test", "acknowledgingUsername": "rwqvzark", "alertConfigId": "{ALERT-CONFIG-ID}", "created": "2019-12-02T20:39:54Z", "eventTypeName": "BACKUP_AGENT_DOWN", "groupId": "{PROJECT-ID}", "id": "{ALERT-ID}", "lastNotified": "2020-04-09T20:21:31Z", "links": [ ], "status": "OPEN", "tags": [], "typeName": "AGENT", "updated": "2020-04-10T19:14:38Z"}