/ /

Mediciones y alertas

Configuraciones de Alerta

Configuraciones de Alerta

Obtener alertas abiertas para la configuración de alerta

Nota

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

URL base: https://cloud.mongodb.com/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.	`1`
elementosPorPágina	Número	Opcional	Número de elementos a devolver por página, hasta un máximo de 500.	`100`
bonito	booleano	Opcional	Indicador que señala si el cuerpo de la respuesta debe estar en formato prettyprint.	`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 o al código de estado. Para remediarlo, establezca `envelope : true` en la query. Para los endpoints que devuelven una lista de resultados, el objeto `content` es un sobre. Cloud Manager añade el campo `status` al cuerpo de la respuesta.	`false`
backupJobsEnabledOnly	booleano	Opcional	Indicador que indica si se deben excluir los demonios que no están habilitados para hacer copias de seguridad de bases de datos de la respuesta. Establece esto en `false` para incluir las configuraciones del demonio con la bandera `backupJobsEnabled` establecida en `false`.	`true`

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 objetos result, un arreglo de objetos link y un recuento del número total de objetos result recuperados.

Nombre	Tipo	Descripción
`results`	arreglo	El arreglo incluye un objeto para cada elemento detallado en la sección del `results` documento incrustado.
`links`	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.
`totalCount`	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	ISO 8601 cuando se haya reconocido la alerta. Se rellena si se ha reconocido la alerta.
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 `BACKUP`, `REPLICA_SET` y `CLUSTER`.
Nombre del clúster	string	Nombra el clúster al que se aplica esta alerta. Se llena para las alertas `BACKUP`, `REPLICA_SET` y `CLUSTER`.
creado	string	ISO 8601 cuando se abrió la alerta.
valorActual	Objeto	Valor actual de la métrica que activó la alerta. Poblado para las alertas de `HOST_METRIC`.
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: `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 incluyen: 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 `ADD_HOST_AUDIT` `ADD_HOST_TO_REPLICA_SET_AUDIT` `ATTEMPT_KILLOP_AUDIT` `ATTEMPT_KILLSESSION_AUDIT` `DB_PROFILER_DISABLE_AUDIT` `DB_PROFILER_ENABLE_AUDIT` `DELETE_HOST_AUDIT` `DISABLE_HOST_AUDIT` `HIDE_AND_DISABLE_HOST_AUDIT` `HIDE_HOST_AUDIT` `HOST_DOWN` `HOST_EXPOSED` `HOST_IP_CHANGED_AUDIT` `HOST_LOCKED_DOWN` `HOST_RECOVERING` `HOST_RESTARTED` `HOST_ROLLBACK` `HOST_SECURITY_CHECKUP_NOT_MET` `HOST_SSL_CERTIFICATE_CURRENT` `HOST_SSL_CERTIFICATE_STALE` `OUTSIDE_METRIC_THRESHOLD` `PAUSE_HOST_AUDIT` `REMOVE_HOST_FROM_REPLICA_SET_AUDIT` `RESUME_HOST_AUDIT` `UNDELETE_HOST_AUDIT` `VERSION_BEHIND` 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` `PRIMARY_ELECTED` `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_GROUP` `JOINED_ORG` `JOINED_TEAM` `REMOVED_FROM_GROUP` `REMOVED_FROM_ORG` `REMOVED_FROM_TEAM` `REQUESTED_TO_JOIN_GROUP` `USER_ROLES_CHANGED_AUDIT` Para revisar la lista completa de eventos que generan alertas y sus descripciones, consulta Tipos de alerta.
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 `HOST`, `HOST_METRIC` y `REPLICA_SET`.
hostnameAndPort	string	Nombre de host y puerto de cada host al que se aplica la alerta. Se ha rellenado para las alertas `HOST`, `HOST_METRIC` y `REPLICA_SET`.
ID	string	Identificador único para la alerta.
Última notificación	string	ISO 8601 cuando se envió la última notificación para esta alerta. Se completa si se han enviado notificaciones.
metricName	string	Nombre de la medida cuyo valor superó el umbral. Se rellena si `"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"`. 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 `HOST`, `HOST_METRIC`, `BACKUP` y `REPLICA_SET` alertas.
resuelto	string	ISO 8601 cuando se cerró la alerta. Se rellena si `"status" : "CLOSED"`.
nombreTipoFuente	string	Para alertas `BACKUP`, el tipo de servidor que se está respaldando. Los valores aceptados son: `REPLICA_SET` `SHARDED_CLUSTER` `CONFIG_SERVER`
Estado	string	Estado actual de la alerta. Los valores aceptados son: `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`
typeName	string	Este campo está obsoleto y será ignorado.
actualizado	string	ISO 8601 cuando se actualizó por última vez la alerta.

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}/alertConfigs/{ALERT-CONFIG-ID}/alerts"

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

{
  "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
}

Volver

Borrar

Eventos

Obtener alertas abiertas para la configuración de alerta

Nota

Resource

Parámetros de ruta de solicitud

Parámetros de Solicitud Query

Parámetros del cuerpo de la solicitud

Respuesta

Documento de respuesta

results embeddedDocument

Nota

Solicitud de ejemplo

Respuesta de ejemplo

Encabezado de respuesta

Respuesta del cuerpo

`results` embeddedDocument