Reconocer una alerta

Nota

Grupos y proyectos son términos sinónimos. Su {PROJECT-ID} es el mismo que su ID del grupo. Para los grupos existentes, el ID del grupo se mantiene igual. Esta página utiliza el término más familiar grupo cuando se refiere a descripciones. El endpoint permanece tal como se indica en el documento.

Resource

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

PATCH /groups/{PROJECT-ID}/alerts/{ALERT-ID}

Parámetros de ruta de solicitud

Parameter	Tipo	Necesidad	Descripción
`PROJECT-ID`	string	Requerido	Identificador único para el proyecto en el que se establece esta alerta.
`ALERT-ID`	string	Requerido	Identificador único para la alerta.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
bonito	booleano	Opcional	Indicador que especifica si el cuerpo de la respuesta está en formato legible.	`false`
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: `status`: Código de respuesta HTTP `content`: Cuerpo de respuesta esperado	`false`

Parámetros del cuerpo de la solicitud

Campo	Tipo	Necesidad	Descripción
`acknowledged` `Until`	string	Condicional	Marca de tiempo en formato de fecha y hora ISO 8601 en UTC hasta la cual se debe confirmar la alerta. Para reconocer una alerta "para siempre", establece el valor del campo en un gran número de años en el futuro. Se recomienda establecer a 100 años en el futuro. Para desacknowledge una alerta acknowledgida, remueva este parámetro de su solicitud.
`acknowledgement` `Comment`	string	Opcional	Descripción textual del motivo de este reconocimiento. Ops Manager muestra el comentario junto al mensaje de que la alerta ha sido reconocida.

Respuesta

Los campos en el documento de devolución dependen del tipo de alerta:

Nombre	Tipo	Descripción
`acknowledged` `Until`	string	Marca de tiempo en formato de fecha y hora ISO 8601 en UTC hasta la cual se ha confirmado la alerta. Ops Manager devuelve este valor si la alerta ha sido reconocida.
`acknowledgement` `Comment`	string	Comentario dejado por el usuario que reconoció la alerta. Ops Manager devuelve este valor si la alerta ha sido reconocida.
`acknowledging` `Username`	string	Nombre de usuario del usuario que reconoció la alerta. Ops Manager devuelve este valor 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. Ops Manager devuelve este valor si `"eventTypeName" : "SHARDED_CLUSTER"`
`clusterName`	string	Nombre del clúster al que se aplica esta alerta. Ops Manager devuelve este valor si `"eventTypeName" : "SHARDED_CLUSTER"`
`created`	string	Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se abrió la alerta.
`currentValue`	Objeto	Valor actual de la métrica que activó la alerta. Ops Manager devuelve este valor si `"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"`.
`currentValue` `.number`	Número	Valor de la métrica.
`currentValue` `.units`	string	Unidades para el valor. El valor depende del tipo de métrica. 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. Ops Manager puede devolver: `RAW` `BITS` `BYTES` `KILOBITS` `KILOBYTES` `MEGABITS` `MEGABYTES` `GIGABITS` `GIGABYTES` `TERABYTES` `PETABYTES` `MILLISECONDS` `SECONDS` `MINUTES` `HOURS` `DAYS`
`eventTypeName`	string	Nombre del evento que activó la alerta. Los valores aceptados son: agente `AUTOMATION_AGENT_DOWN` `AUTOMATION_AGENT_UP` `BACKUP_AGENT_CONF_CALL_FAILURE` `BACKUP_AGENT_DOWN` `BACKUP_AGENT_UP` `BACKUP_AGENT_VERSION_BEHIND` `BACKUP_AGENT_VERSION_CURRENT` `MONITORING_AGENT_DOWN` `MONITORING_AGENT_UP` `MONITORING_AGENT_VERSION_BEHIND` `MONITORING_AGENT_VERSION_CURRENT` `NEW_AGENT` Configuración de automatización `AUTOMATION_CONFIG_PUBLISHED_AUDIT` Backup `BAD_CLUSTERSHOTS` `CLUSTER_DENYLIST_UPDATED_AUDIT` `CLUSTER_CHECKKPOINT_UPDATED_AUDIT` `CLUSTER_CREDENTIAL_UPDATED_AUDIT` `CLUSTER_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` `CLUSTER_STATE_CHANGED_AUDIT` `CLUSTER_STORAGE_ENGINE_UPDATED_AUDIT` `CLUSTERSHOT_DELETED_AUDIT` `CLUSTERSHOT_EXPIRY_UPDATED_AUDIT` `CONSISTENT_BACKUP_CONFIGURATION` `GOOD_CLUSTERSHOT` `INCONSISTENT_BACKUP_CONFIGURATION` `INITIAL_SYNC_FINISHED_AUDIT` `INITIAL_SYNC_STARTED_AUDIT` `OPLOG_BEHIND` `OPLOG_CURRENT` `RESTORE_REQUESTED_AUDIT` `RESYNC_PERFORMED` `RESYNC_REQUIRED` `RS_DENYLIST_UPDATED_AUDIT` `RS_CREDENTIAL_UPDATED_AUDIT` `RS_ROTATE_MASTER_KEY_AUDIT` `RS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` `RS_STATE_CHANGED_AUDIT` `RS_STORAGE_ENGINE_UPDATED_AUDIT` `SNAPSHOT_DELETED_AUDIT` `SNAPSHOT_EXPIRY_UPDATED_AUDIT` `SYNC_PENDING_AUDIT` `SYNC_REQUIRED_AUDIT` Conector de BI `BI_CONNECTOR_DOWN` `BI_CONNECTOR_UP` clúster `CLUSTER_MONGOS_IS_MISSING` `CLUSTER_MONGOS_IS_PRESENT` `SHARD_ADDED` `SHARD_REMOVED` Explorador de datos accedido `DATA_EXPLORER` `DATA_EXPLORER_CRUD` host `ATTEMPT_KILLOP_AUDIT` `ATTEMPT_KILLSESSION_AUDIT` `DB_PROFILER_DISABLE_AUDIT` `DB_PROFILER_ENABLE_AUDIT` `DISABLE_HOST_AUDIT` `HIDE_AND_DISABLE_HOST_AUDIT` `HIDE_HOST_AUDIT` `HOST_DOWN` `HOST_DOWNGRADED` `HOST_IP_CHANGED_AUDIT` `HOST_NOW_PRIMARY` `HOST_NOW_SECONDARY` `HOST_NOW_STANDALONE` `HOST_RECOVERED` `HOST_RECOVERING` `HOST_SECURITY_CHECKUP_NOT_MET` `HOST_SSL_CERTIFICATE_CURRENT` `HOST_SSL_CERTIFICATE_STALE` `HOST_UP` `HOST_UPGRADED` `INSIDE_METRIC_THRESHOLD` `NEW_HOST` `OUTSIDE_METRIC_THRESHOLD` `PAUSE_HOST_AUDIT` `RESUME_HOST_AUDIT` `UNDELETE_HOST_AUDIT` `VERSION_BEHIND` `VERSION_CHANGED` `VERSION_CURRENT` organización `ALL_ORG_USERS_HAVE_MFA` `ORG_API_KEY_ADDED` `ORG_API_KEY_DELETED` `ORG_EMPLOYEE_ACCESS_RESTRICTED` `ORG_EMPLOYEE_ACCESS_UNRESTRICTED` `ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED` `ORG_PUBLIC_API_ACCESS_LIST_REQUIRED` `ORG_RENAMED` `ORG_TWO_FACTOR_AUTH_OPTIONAL` `ORG_TWO_FACTOR_AUTH_REQUIRED` `ORG_USERS_WITHOUT_MFA` Proyecto `ALL_USERS_HAVE_MULTI_FACTOR_AUTH` `USERS_WITHOUT_MULTI_FACTOR_AUTH` Set de réplicas `CONFIGURATION_CHANGED` `ENOUGH_HEALTHY_MEMBERS` `MEMBER_ADDED` `MEMBER_REMOVED` `MULTIPLE_PRIMARIES` `NO_PRIMARY` `ONE_PRIMARY` `TOO_FEW_HEALTHY_MEMBERS` `TOO_MANY_ELECTIONS` `TOO_MANY_UNHEALTHY_MEMBERS` equipo `TEAM_ADDED_TO_GROUP` `TEAM_CREATED` `TEAM_DELETED` `TEAM_NAME_CHANGED` `TEAM_REMOVED_FROM_GROUP` `TEAM_ROLES_MODIFIED` `TEAM_UPDATED` `USER_ADDED_TO_TEAM` Usuario `INVITED_TO_GROUP` `INVITED_TO_ORG` `JOIN_GROUP_REQUEST_APPROVED_AUDIT` `JOIN_GROUP_REQUEST_DENIED_AUDIT` `JOINED_TEAM` `REMOVED_FROM_TEAM` `REQUESTED_TO_JOIN_GROUP` 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 grupo para el que se abrió esta alerta.
`hostId`	string	identificador único para el host al que corresponde la métrica. Ops Manager devuelve este valor si `"eventTypeName"` se configuró como uno de los siguientes: `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`hostnameAndPort`	string	Nombre de host y puerto de cada host al que se aplica la alerta. Puede ser un nombre de host, un FQDN, una dirección IPv4 o una dirección IPv6. Ops Manager devuelve este valor si `"eventTypeName"` se configuró como uno de los siguientes: `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`id`	string	Identificador único para la alerta.
`lastNotified`	string	Marca de tiempo en formato de fecha y hora ISO 8601 en UTC que indica cuándo se envió la última notificación para esta alerta. Ops Manager devuelve este valor si se han enviado notificaciones.
`links`	Arreglo de objetos	Uno o más enlaces a subrecursos o recursos relacionados. Todos los arreglos `links` en las respuestas incluyen al menos un enlace llamado `self`. Las relaciones entre URLse explican en la Especificación de enlaces web.
`metricName`	string	Nombre de la medición cuyo valor excedió el umbral. Ops Manager devuelve este valor si `"eventTypeName"` se configuró en `OUTSIDE_METRIC_THRESHOLD`. Para conocer los valores posibles, consulte Tipos de medición para alertas.
`replicaSetName`	string	Nombre del set de réplicas. Ops Manager devuelve este valor si `"eventTypeName"` se configuró como uno de los siguientes: `BACKUP` `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`resolved`	string	Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se cerró la alerta. Ops Manager devuelve este valor si `"status" : "CLOSED"`.
`status`	string	Estado actual de la alerta. Ops Manager puede devolver uno de los siguientes: `TRACKING` La condición de alerta existe, pero no ha persistido más allá del retraso de notificación definido. Para obtener más detalles, consulta Parámetros de query de solicitud. `OPEN` `CLOSED` `CANCELLED`
`sourceTypeName`	string	Tipo de host que se respalda cuando `"eventTypeName" : "BACKUP"`. Ops Manager puede devolver uno de los siguientes: `REPLICA_SET` `SHARDED_CLUSTER` `CONFIG_SERVER`
`tags`	arreglo de string	Identificar las etiquetas establecidas para esta alerta.
`updated`	string	Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se actualizó por última vez la alerta.

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://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-CONFIG-ID}"
6      --data '
7        {
8          "acknowledgedUntil": "2016-04-15T00:00:00-0400",
9          "acknowledgementComment": "This is normal. Please ignore."
10        }'

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   "id" : "{ALERT-CONFIG-ID}",
3   "groupId" : "{PROJECT-ID}",
4   "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
5   "status" : "OPEN",
6   "acknowledgedUntil" : "2014-04-15T04:00:00Z",
7   "acknowledgementComment" : "This is normal. Please ignore.",
8   "acknowledgingUsername" : "someuser@example.com",
9   "created" : "2014-04-03T20:28:14Z",
10   "updated" : "2014-04-03T20:33:14Z",
11   "lastNotified" : "2014-04-03T20:33:23Z",
12   "metricName": "ASSERTS_REGULAR",
13   "currentValue" : {
14     "number" : 0.0,
15     "units" : "RAW"
16   },
17   "links" : []
18 }

Volver

Obtenga uno

Configuraciones de Alerta

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://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-CONFIG-ID}"
6	--data '
7	{
8	"acknowledgedUntil": "2016-04-15T00:00:00-0400",
9	"acknowledgementComment": "This is normal. Please ignore."
10	}'

1	{
2	"id" : "{ALERT-CONFIG-ID}",
3	"groupId" : "{PROJECT-ID}",
4	"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
5	"status" : "OPEN",
6	"acknowledgedUntil" : "2014-04-15T04:00:00Z",
7	"acknowledgementComment" : "This is normal. Please ignore.",
8	"acknowledgingUsername" : "someuser@example.com",
9	"created" : "2014-04-03T20:28:14Z",
10	"updated" : "2014-04-03T20:33:14Z",
11	"lastNotified" : "2014-04-03T20:33:23Z",
12	"metricName": "ASSERTS_REGULAR",
13	"currentValue" : {
14	"number" : 0.0,
15	"units" : "RAW"
16	},
17	"links" : []
18	}