/ /

Gerente de Operaciones

Reconocer una alerta global

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 correctamente a este punto final 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 la ruta de solicitud

Nombre	Tipo	Descripción
`ALERT-ID`	string	Identificador único del periodo de mantenimiento que deseas reconocer.

Parámetros de Solicitud Query

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que señala si el cuerpo de la respuesta debe estar en un pretty-print formato.

false

envelope

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 envelope=true en la consulta.

Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuesta HTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Body Parameter	Tipo	Necesidad	Descripción
`acknowledgedUntil`	string	Requerido	Marca de tiempo en ISO 8601 formato de fecha y hora en UTC a través del cual reconoces esta alerta. Después de que transcurra este tiempo, Ops Manager devuelve la alerta a sin confirmar. 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.
`acknowledgementComment`	string	Opcional	Comentario que describe el reconocimiento de la alerta.

Respuesta

Nombre

Tipo

Descripción

acknowledgedUntil

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.

acknowledgementComment

string

Comentario que el usuario que reconoció esta alerta dejó. Ops Manager presenta este campo si un usuario reconoció esta alerta.

acknowledgingUsername

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.

alertConfigId

string

Identificador único de la configuración global de alertas que activó esta alerta.

clusterId

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:

clusterName

string

Nombre el clúster al que se aplica esta alerta. Ops Manager devuelve este campo para las alertas globales en las categorías:

created

string

Marca de tiempo en ISO 8601 en formato de fecha y hora en UTC cuando se creó la alerta.

currentValue

Objeto

Valor actual de la métrica que activó la alerta. Ops Manager devuelve este campo para las alertas globales de la categoría de host.

currentValue.number

Número

Valor actual de la métrica.

currentValue.units

string

Unidades para currentValue.number. Las unidades dependen del tipo de métrica.

Los valores aceptados son:

RAW
BITS
BYTES
KILOBITS
KILOBYTES
MEGABITS
MEGABYTES
GIGABITS
GIGABYTES
TERABYTES
PETABYTES
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Por ejemplo, una métrica que mide el consumo de memoria puede usar BYTES, mientras que una métrica que mide el tiempo puede usar HOURS.

eventTypeName

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.

groupId

string

Identificador único del proyecto para el cual se abrió esta alerta.

hostId

string

Identificador único del host al que corresponde la métrica. Ops Manager devuelve este campo para alertas globales en las siguientes categorías:

hostnameAndPort

string

Nombre de host y puerto de cada host al que se aplica la alerta. El nombre de host solo puede ser un nombre de host, un FQDN, una dirección IPv4 o una dirección IPv6. Ops Manager devuelve este campo para las alertas globales en las siguientes categorías:

id

string

Identificador único de la alerta.

lastNotified

string

Marca de tiempo en ISO 8601 formato de fecha y hora en UTC cuando se envió la última notificación para esta alerta. Ops Manager muestra esto si Ops Manager envía notificaciones.

metricName

string

Nombre de la medida cuyo valor superó el umbral. Ops Manager devuelve este campo si "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD".

Para posibles valores, consulta Tipos de mediciones para alertas globales.

replicaSetName

string

Nombre del set de réplicas. Ops Manager devuelve este campo para alertas globales en las categorías de:

resolved

string

Timestamp en ISO 8601 formato de fecha y hora en UTC cuando se cerró la alerta. Ops Manager devuelve este campo para alertas globales cuando "status" : "CLOSED".

sourceTypeName

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:

REPLICA_SET
SHARDED_CLUSTER
CONFIG_SERVER

status

string

Estado actual de la alerta. Los valores posibles que se pueden devolver incluyen:

`TRACKING`	Existen condiciones de alerta, pero la condición no ha persistido el tiempo suficiente para activar una alerta.
`OPEN`	La alerta está abierta.
`CLOSED`	La alerta está cerrada.
`CANCELLED`	Se cancela la alerta.

tags

Arreglo de cadenas

Etiquetas asociadas a esta alerta.

typeName

string

Este campo está obsoleto y será ignorado.

updated

string

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando esta alerta fue actualizada por última vez.

Solicitud de ejemplo

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlerts/{ALERT-ID}" \
6      --data '{
7         "acknowledgedUntil":"2020-04-10T20:21:31Z",
8         "acknowledgementComment":"test"
9        }'

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 201 Created
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   "acknowledgedUntil": "2020-04-10T20:20:38Z",
3   "acknowledgementComment": "test",
4   "acknowledgingUsername": "rwqvzark",
5   "alertConfigId": "{ALERT-CONFIG-ID}",
6   "created": "2019-12-02T20:39:54Z",
7   "eventTypeName": "BACKUP_AGENT_DOWN",
8   "groupId": "{PROJECT-ID}",
9   "id": "{ALERT-ID}",
10   "lastNotified": "2020-04-09T20:21:31Z",
11   "links": [
12   ],
13   "status": "OPEN",
14   "tags": [],
15   "typeName": "AGENT",
16   "updated": "2020-04-10T19:14:38Z"
17 }

Volver

Obtenga uno

Configuraciones globales de alertas

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlerts/{ALERT-ID}" \
6	--data '{
7	"acknowledgedUntil":"2020-04-10T20:21:31Z",
8	"acknowledgementComment":"test"
9	}'

1	{
2	"acknowledgedUntil": "2020-04-10T20:20:38Z",
3	"acknowledgementComment": "test",
4	"acknowledgingUsername": "rwqvzark",
5	"alertConfigId": "{ALERT-CONFIG-ID}",
6	"created": "2019-12-02T20:39:54Z",
7	"eventTypeName": "BACKUP_AGENT_DOWN",
8	"groupId": "{PROJECT-ID}",
9	"id": "{ALERT-ID}",
10	"lastNotified": "2020-04-09T20:21:31Z",
11	"links": [
12	],
13	"status": "OPEN",
14	"tags": [],
15	"typeName": "AGENT",
16	"updated": "2020-04-10T19:14:38Z"
17	}