/ /

/ /

Recibe una alerta

Cloud Manager dejará de admitir la Automatización, la Copia de seguridad y la Supervisión para MongoDB 3.6 y 4.0 después del 30de agosto de 2024. Por favor actualiza tu implementación de MongoDB o migra a Atlas.

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es el mismo que tu id. de proyecto. Para los grupos existentes, su ID de grupo/ID del grupo seguirá siendo el mismo. Esta página utiliza el término más familiar grupo al referirse a descripciones. El endpoint se mantiene tal como se indica en el documento.

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

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

Parámetros de la ruta de solicitud

Parameter	Tipo	Descripción
PROJECT-ID	string	(Obligatorio.) Identificador del proyecto.
ALERT-ID	string	(Obligatorio). Identificador de 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 señala si el cuerpo de respuesta debe estar en un prettyprint 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

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

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

Nombre	Tipo	Descripción
`acknowledged` `Until`	string	Marca temporal en ISO 8601 formato de fecha y hora en UTC hasta que la alerta haya sido reconocida. Cloud Manager devuelve este valor si se ha reconocido la alerta.
`acknowledgement` `Comment`	string	Comentario dejado por el usuario que reconoció la alerta. Cloud Manager devuelve este valor si se ha reconocido la alerta.
`acknowledging` `Username`	string	Nombre de usuario del usuario que reconoció la alerta. Cloud Manager devuelve este valor si se ha reconocido 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. Cloud Manager retorna este valor si `"eventTypeName" : "SHARDED_CLUSTER"`
`clusterName`	string	Nombre del clúster al que se aplica esta alerta. Cloud Manager retorna este valor si `"eventTypeName" : "SHARDED_CLUSTER"`
`created`	string	Referencia temporal en ISO 8601 fecha y formato de hora en UTC cuando se abrió la alerta.
`currentValue`	Objeto	Valor actual de la métrica que activó la alerta. Cloud 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. Cloud 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` Facturación `ACCOUNT_DOWNGRADED` `ACCOUNT_UPGRADED` `CHARGE_FAILED` `CHARGE_SUCCEEDED` `CHECK_PAYMENT_RECEIVED` `CREDIT_CARD_ABOUT_TO_EXPIRE` `CREDIT_CARD_CURRENT` `CREDIT_ISSUED` `DAILY_BILL_OVER_THRESHOLD` `DAILY_BILL_UNDER_THRESHOLD` `DISCOUNT_APPLIED` `INVOICE_ADDRESS_ADDED` `INVOICE_ADDRESS_CHANGED` `INVOICE_CLOSED` `PAYMENT_FORGIVEN` `PENDING_INVOICE_OVER_THRESHOLD` `PENDING_INVOICE_UNDER_THRESHOLD` `PREPAID_PLAN_ACTIVATED` `PROMO_CODE_APPLIED` `REFUND_ISSUED` `STALE_PENDING_INVOICES` `WIRE_TRANSFER_PAYMENT_RECEIVED` clúster `CLUSTER_MONGOS_IS_MISSING` `CLUSTER_MONGOS_IS_PRESENT` `SHARD_ADDED` `SHARD_REMOVED` Explorador de datos accedido `DATA_EXPLORER` `DATA_EXPLORER_CRUD` Copia de seguridad de disco `CPS_RESTORE_REQUESTED_AUDIT` 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_EXPOSED` `HOST_IP_CHANGED_AUDIT` `HOST_LOCKED_DOWN` `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_ACTIVATED` `ORG_ADMIN_SUSPENDED` `ORG_API_KEY_ADDED` `ORG_API_KEY_DELETED` `ORG_CREDIT_CARD_ABOUT_TO_EXPIRE` `ORG_CREDIT_CARD_ADDED` `ORG_CREDIT_CARD_CURRENT` `ORG_CREDIT_CARD_UPDATED` `ORG_DAILY_BILL_OVER_THRESHOLD` `ORG_DAILY_BILL_UNDER_THRESHOLD` `ORG_EMPLOYEE_ACCESS_RESTRICTED` `ORG_EMPLOYEE_ACCESS_UNRESTRICTED` `ORG_GROUP_CHARGES_OVER_THRESHOLD` `ORG_GROUP_CHARGES_UNDER_THRESHOLD` `ORG_INVOICE_OVER_THRESHOLD` `ORG_INVOICE_UNDER_THRESHOLD` `ORG_LOCKED` `ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED` `ORG_PUBLIC_API_ACCESS_LIST_REQUIRED` `ORG_RENAMED` `ORG_SUSPENDED` `ORG_TEMPORARILY_ACTIVATED` `ORG_TWO_FACTOR_AUTH_OPTIONAL` `ORG_TWO_FACTOR_AUTH_REQUIRED` `ORG_USERS_WITHOUT_MFA` Proyecto `ALL_USERS_HAVE_MULTI_FACTOR_AUTH` `DELINQUENT` `PAID_IN_FULL` `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` Caso de soporte `CASE_CREATED` 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_GROUP` `REMOVED_FROM_ORG` `REMOVED_FROM_TEAM` `REQUESTED_TO_JOIN_GROUP`
`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. Cloud Manager devuelve este valor si `"eventTypeName"` se estableció en 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. Cloud Manager devuelve este valor si `"eventTypeName"` se estableció en uno de los siguientes: `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`id`	string	Identificador único para 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. Cloud Manager devuelve este valor si se han enviado notificaciones.
`links`	Arreglo de objetos	Uno o más enlaces a subrecursos y/o recursos relacionados. Todos los `links` arreglos en las respuestas incluyen al menos un enlace llamado `self`. Las relaciones entre URLs se explican en la Especificación de Enlaces Web.
`metricName`	string	Nombre de la medición cuyo valor excedió el umbral. Cloud Manager devuelve este valor si `"eventTypeName"` se estableció en `OUTSIDE_METRIC_THRESHOLD`. Para conocer los valores posibles, consulte Tipos de medición para alertas.
`replicaSetName`	string	Nombre del set de réplicas. Cloud Manager devuelve este valor si `"eventTypeName"` se estableció en uno de los siguientes: `BACKUP` `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`resolved`	string	Fecha y hora en ISO 8601 en formato UTC cuando se cerró la alerta. Cloud Manager devuelve este valor si `"status" : "CLOSED"`.
`status`	string	Estado actual de la alerta. Cloud 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 está respaldando cuando `"eventTypeName" : "BACKUP"`. Cloud Manager puede devolver uno de los siguientes: `REPLICA_SET` `SHARDED_CLUSTER` `CONFIG_SERVER`
`tags`	arreglo de string	Identificar las etiquetas establecidas para esta alerta.
`typeName`	string	Campo obsoleto. \|mms\| lo ignora.
`updated`	string	Marca de tiempo en ISO 8601 en formato de fecha y hora en UTC cuando la alerta se actualizó por última vez.

Tipos de medición para alertas

El recurso alerts devuelve tipos de medición en el campo metricName. El campo sólo está presente si eventTypeName se establece en OUTSIDE_METRIC_THRESHOLD.

Medidas del host

`ASSERT_REGULAR` `ASSERT_WARNING` `ASSERT_MSG` `ASSERT_USER`	Tasa de afirmaciones para un proceso de MongoDB que se encuentra en el documento `asserts` que genera el comando serverStatus.
`BACKGROUND_FLUSH_AVG`	Cantidad de datos descartados en segundo plano.
`CACHE_BYTES_READ_INTO` `CACHE_BYTES_WRITTEN_FROM` `CACHE_DIRTY_BYTES` `CACHE_USED_BYTES` `TICKETS_AVAILABLE_READS` `TICKETS_AVAILABLE_WRITE`	Cantidad de bytes en la caché del motor de almacenamiento WiredTiger y tickets encontrados en los documentos `wiredTiger.cache` y `wiredTiger.concurrentTransactions` que genera el comando serverStatus.
`CONNECTIONS`	Número de conexiones a un proceso MongoDB encontradas en el `connections` documento que genera el comando serverStatus.
`CURSORS_TOTAL_OPEN` `CURSORS_TOTAL_TIMED_OUT`	Número de cursores para un proceso MongoDB encontrado en el `metrics.cursor` documento que genera el comando serverStatus.
`EXTRA_INFO_PAGE_FAULTS` `GLOBAL_ACCESSES_NOT_IN_MEMORY` `GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN`	Números de `Memory Issues` y `Page Faults` para un proceso MongoDB.
`GLOBAL_LOCK_CURRENT_QUEUE_TOTAL` `GLOBAL_LOCK_CURRENT_QUEUE_READERS` `GLOBAL_LOCK_CURRENT_QUEUE_WRITERS`	Número de operaciones en espera por bloqueos para el proceso de MongoDB que genera el comando serverStatus. Cloud Manager calcula estos valores en función del tipo de motor de almacenamiento.
`INDEX_COUNTERS_BTREE_ACCESSES` `INDEX_COUNTERS_BTREE_HITS` `INDEX_COUNTERS_BTREE_MISSES` `INDEX_COUNTERS_BTREE_MISS_RATIO`	Número de operaciones de índice btree.
`JOURNALING_COMMITS_IN_WRITE_LOCK` `JOURNALING_MB` `JOURNALING_WRITE_DATA_FILES_MB`	Número de operaciones de registrar en la bitácora.
`MEMORY_RESIDENT` `MEMORY_VIRTUAL` `MEMORY_MAPPED` `COMPUTED_MEMORY`	Cantidad de memoria para un proceso MongoDB que se encuentra en el `mem` documento que recopila el comando serverStatus.
`NETWORK_BYTES_IN` `NETWORK_BYTES_OUT` `NETWORK_NUM_REQUESTS`	Cantidad de rendimiento para el proceso de MongoDB encontrado en el documento `network` que el comando serverStatus recopila.
`OPLOG_RATE_GB_PER_HOUR` `OPLOG_MASTER_TIME` `OPLOG_MASTER_LAG_TIME_DIFF` `OPLOG_SLAVE_LAG_MASTER_TIME`	Duración y rendimiento del registro de operaciones del proceso MongoDB.
`DB_STORAGE_TOTAL` `DB_DATA_SIZE_TOTAL`	Espacio de almacenamiento en disco adquirido del comando `dbStats` de MongoDB.
`OPCOUNTER_CMD` `OPCOUNTER_QUERY` `OPCOUNTER_UPDATE` `OPCOUNTER_DELETE` `OPCOUNTER_GETMORE` `OPCOUNTER_INSERT`	Tasa de operaciones de base de datos en un proceso de MongoDB desde la última vez que se inició el proceso que se encuentra en el documento `opcounters` que el comando serverStatus recopila.
`OPCOUNTER_REPL_CMD` `OPCOUNTER_REPL_UPDATE` `OPCOUNTER_REPL_DELETE` `OPCOUNTER_REPL_INSERT`	Tasa de operaciones de la base de datos en los secundarios de MongoDB encontrada en el documento `opcountersRepl` que recopila el comando serverStatus.
`DOCUMENT_METRICS_RETURNED` `DOCUMENT_METRICS_INSERTED` `DOCUMENT_METRICS_UPDATED` `DOCUMENT_METRICS_DELETED`	Promedio de documentos devueltos, insertados, actualizados o eliminados por segundo durante un periodo de tiempo seleccionado.
`OPERATIONS_SCAN_AND_ORDER`	Tasa promedio de operaciones por segundo durante un período de tiempo seleccionado que realiza una ordenación, pero no puede realizar la ordenación utilizando un índice.
`OP_EXECUTION_TIME_READS` `OP_EXECUTION_TIME_WRITES` `OP_EXECUTION_TIME_COMMANDS`	Tiempo promedio de ejecución en milisegundos por operación de lectura, guardar o comando durante un período de tiempo seleccionado. Disponible para hosts que ejecutan MongoDB 3.4 o posterior.
`RESTARTS_IN_LAST_HOUR`	Número de veces que el host se reinició durante la hora anterior.
`SYSTEM_MEMORY_USED` `SYSTEM_MEMORY_FREE` `SYSTEM_MEMORY_AVAILABLE`	Uso de memoria física, en bytes.
`SYSTEM_NETWORK_BYTES_IN` `SYSTEM_NETWORK_BYTES_OUT`	Rendimiento de red en bytes por segundo.
`SWAP_USAGE_USED` `SWAP_USAGE_FREE`	Cantidad total de espacio swap en uso.

`QUERY_EXECUTOR_SCANNED`	Tasa promedio por segundo para escanear elementos del índice durante queries y evaluaciones del plan del query encontrada en el valor de `totalKeysExamined` del comando explain.
`QUERY_EXECUTOR_SCANNED_OBJECTS`	Tasa promedio de documentos escaneados por segundo durante las queries y evaluaciones de los planes del query encontrados en el valor de `totalDocsExamined` en el comando explain.
`QUERY_TARGETING_SCANNED_PER_RETURNED`	Proporción entre el número de elementos de índices escaneados y el número de documentos devueltos.
`QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED`	Relación entre el número de documentos escaneados y el número de documentos devueltos.

Solicitud de ejemplo

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-ID}"

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

{
  "alertConfigId" : "5b43d04087d9d6357de591aa",
  "created" : "2019-07-26T21:12:19Z",
  "currentValue" : {
    "number" : 100,
    "units" : "RAW"
  },
  "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
  "humanReadable" : "Project: testProj
                     Organization: testOrg
                     Alert acknowledged by user@example.com until 2019/10/17 19:48 GMT.
                     Comment: N/A
                     Connections has gone below 1000
                     mycluster.example.com:27017
                     Created: 2019/10/17 15:26 GMT
                     Replica Set: cluster0-shard-0
                     Type: Primary
                     Current Value: 100"
  "groupId" : "535683b3794d371327b",
  "hostnameAndPort" : "mycluster.example.com:27017",
  "id" : "533cb4b8e4b0f1820cdabc7f",
  "lastNotified" : "2019-07-26T21:13:48Z",
  "metricName" : "CONNECTIONS",
  "replicaSetName" : "mycluster",
  "resolved" : "2019-07-26T21:13:42Z",
  "status" : "CLOSED",
  "typeName" : "HOST_METRIC",
  "updated" : "2019-07-26T21:13:42Z",
  "links" : [ ... ]
}

Volver

Obtener todas las alertas

Reconocer una alerta