Join us at MongoDB.local London on 7 May to unlock new possibilities for your data. Use WEB50 to save 50%.
Register now >
Docs Menu
Docs Home
/ /
Configuraciones de Alerta
Docs Home
/ /
Mediciones y alertas
/
Configuraciones de Alerta
Docs Home
/
Gestión
/
Cloud Manager
/
API
/
Recursos
/
Mediciones y alertas
/
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 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}/alertConfigs/{ALERT-CONFIG-ID}/alerts

Parámetros de la 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

Bandera que indica si el cuerpo de la respuesta debe estar en formato 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 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 de la respuesta los daemons no habilitados para realizar copias de seguridad de bases de datos. Establezca este valor en false para incluir las configuraciones de daemon con el indicador backupJobsEnabled establecido 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 JSON de respuesta incluye una matriz de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.

Nombre
Tipo
Descripción

results

arreglo

La matriz incluye un objeto para cada elemento detallado en el Sección 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

Marca de tiempo en ISO 8601 formato de fecha y hora en UTC cuando la alerta ha sido reconocida. Se completa si la alerta ha sido reconocida.

reconociendoNombreDeUsuario

string

Nombre de usuario del usuario que reconoció la alerta. Se completa si la alerta ha sido reconocida.

reconocimientoComentario

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

Referencia temporal en ISO 8601 fecha y formato de hora en UTC 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.

valorActual.unidades

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

nombreDeTipoDeEvento

string

Nombre del evento que activó la alerta.

Los valores incluyen:

agente

Configuración de automatización

Backup

Conector de BI

Facturación

clúster

Explorador de datos accedido

Copia de seguridad de disco

Host

Organización

Proyecto

Set de réplicas

Caso de soporte

equipo

Usuario

Para revisar la lista completa de eventos que generan alertas y sus descripciones, consulte 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

Marca de tiempo en formato ISO 8601 de fecha y hora UTC del último envío de notificaciones para esta alerta. Se rellena si se enviaron notificaciones.

nombremétrico

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 conjunto de réplicas. Se completa para las alertas HOST, HOST_METRIC, BACKUP y REPLICA_SET.

resuelto

string

Timestamp en ISO 8601 formato de fecha y hora en UTC cuando se cerró la alerta. Se completará 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

Marca de tiempo en ISO 8601 en formato de fecha y hora en UTC cuando la alerta se actualizó por última vez.

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

Next

Eventos

En esta página