Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/
API
/
Recursos da API de administração do Ops Manager
/
Medições e alertas
/
Configurações de alerta global

Obter todos os alertas abertos acionados por uma configuração de alerta global

Nesta página

  • Funções obrigatórias
  • Solicitar
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • documento de resposta
  • results documento incorporado
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

Recupere todos os alertas abertos acionados por uma configuração de alerta global identificada por seu GLOBAL-ALERT-CONFIG-ID.

Funções obrigatórias

Você pode chamar esse endpoint com sucesso com qualquer um dos seguintes roles atribuídos:

  • Global Owner

  • Global Monitoring Admin

Solicitar

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

GET /globalAlertConfigs/{GLOBAL-ALERT-CONFIG-ID}/alerts

Parâmetros do caminho da solicitação

Nome
Tipo
necessidade
Descrição
{GLOBAL-ALERT-CONFIG-ID}
string
Obrigatório
Identificador exclusivo da configuração de alerta global para a qual você deseja recuperar alertas abertos.

Solicitar parâmetros de query

Nome
Tipo
necessidade
Descrição
Default
pageNum
número
Opcional
Um inteiro baseado que retorna uma subseção de resultados.
1
itemsPerPage
número
Opcional
Número de itens a serem devolvidos por página, até um máximo de 500.
100
pretty
booleano
Opcional
Sinalizador que indica se o corpo da resposta deve estar em um prettyprint formato.
false
envelope
booleano
Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes do API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure envelope : true na consulta.

Para endpoints que retornam uma lista de resultados, o objeto results é um envelope. O Ops Manager adiciona o campo status ao corpo da resposta.

false
backupJobsEnabledOnly
booleano
Opcional
Sinalizador que indica se os daemon não habilitados para reconhecimento de data center devem ser excluídos da resposta. Defina isso como false para incluir configurações de daemon com o sinalizador backupJobsEnabled definido como false.
true

Parâmetros do corpo da solicitação

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Resposta

documento de resposta

O documento JSON de resposta inclui uma array de objetos result , uma array de objetos link e uma contagem do número total de objetos result recuperados.

Nome
Tipo
Descrição
results
array
A array inclui um objeto para cada item detalhado na seção Documento incorporadoresults .
links
array
A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web.
totalCount
número
Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado.

results documento incorporado

Cada resultado é um alerta.

Nome
Tipo
Descrição
acknowledgedUntil
string
Carimbo de data/hora na ISO 8601 formato de data e hora em UTC pelo qual o alerta foi confirmado. MongoDB Ops Manager apresenta este campo se um usuário reconhecer este alerta.
acknowledgementComment
string
Comentário que o usuário que reconheceu este alerta esquerda. O Ops Manager apresenta este campo se um usuário reconheceu este alerta.
acknowledgingUsername
string
Nome de usuário do Ops Manager do usuário que reconheceu o alerta. O Ops Manager apresenta este campo se um usuário reconheceu este alerta.
alertConfigId
string
Identificador exclusivo da configuração de alerta global que acionou este alerta.
clusterId
string

Identificador único do cluster ao qual este alerta se aplica. O Ops Manager retorna esse campo para alertas globais nas categorias de:

clusterName
string

Dê um nome ao cluster ao qual esse alerta se aplica. O Ops Manager retorna esse campo para alertas globais nas categorias de:

created
string
Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o alerta foi criado.
currentValue
objeto
Valor atual da métrica que acionou o alerta. O Ops Manager retorna esse campo para alertas globais na categoria de host.
currentValue.number
número
Valor atual da métrica.
currentValue.units
string

Unidades para currentValue.number. As unidades dependem do tipo de métrica.

Os valores aceitos são:

  • RAW

  • BITS

  • BYTES

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • GIGABITS

  • GIGABYTES

  • TERABYTES

  • PETABYTES

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Por exemplo, uma métrica que mede o consumo de memória pode usar BYTES, enquanto uma métrica que mede o tempo pode usar HOURS.

eventTypeName
string

Nome do evento que acionou o alerta.

Para revisar os tipos de eventos que geram alertas, consulte Tipos de Alerta.

Para obter uma lista completa de eventos incluídos no registro de auditoria do Ops Manager, consulte Eventos de auditoria.

groupId
string
Identificador único do projeto para o qual este alerta foi aberto.
hostId
string

Identificador único do host ao qual a métrica pertence. O Ops Manager retorna esse campo para alertas globais nas categorias de:

hostnameAndPort
string

Nome do host e porta de cada host ao qual o alerta se aplica. O nome do host pode ser apenas um nome de host, um FQDN, um endereço IPv4 ou um endereço IPv6 . O Ops Manager retorna esse campo para alertas globais nas categorias de:

id
string
Identificador único do alerta.
lastNotified
string
Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando a última notificação foi enviada para este alerta. MongoDB Ops Manager exibe isso se o MongoDB Ops Manager enviou notificações.
metricName
string

Nome da medição cujo valor ficou fora do limite. Ops Manager retorna este campo se "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD".

Para obter valores possíveis, consulte Tipos de medição para Alertas Globais.

replicaSetName
string

Nome do conjunto de réplicas. O Ops Manager retorna esse campo para alertas globais nas categorias de:

resolved
string
Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o alerta foi fechado. MongoDB Ops Manager retorna esse campo para alertas globais quando "status" : "CLOSED".
sourceTypeName
string

Tipo de host que está sendo copiado. O Ops Manager retorna esse campo para alertas globais na categoria de backup. Os possíveis valores que podem ser retornados incluem:

  • REPLICA_SET

  • SHARDED_CLUSTER

  • CONFIG_SERVER

status
string

Estado atual do alerta. Os possíveis valores que podem ser retornados incluem:

TRACKING
Existem condições de alerta, mas a condição não persiste por tempo suficiente para trigger um alerta.
OPEN
O alerta está aberto.
CLOSED
O alerta está fechado.
CANCELLED
O alerta foi cancelado.
tags
array de strings
Marcações associadas a este alerta.
typeName
string
Este campo é preterido e será ignorado.
updated
string
Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando este alerta foi atualizado pela última vez.

Exemplo de solicitação

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2     --header "Accept: application/json" \
3     --include \
4     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs/{GLOBAL-ALERT-CONFIG-ID}/alerts"

Exemplo de resposta

Cabeçalho de resposta

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}

Corpo de resposta

1{
2  "links": [],
3  "results": [{
4    "alertConfigId": "{ALERT-CONFIG-ID}",
5    "created": "2019-11-29T20:26:30Z",
6    "eventTypeName": "BACKUP_AGENT_DOWN",
7    "groupId": "{PROJECT-ID}",
8    "id": "{ALERT-ID}",
9    "lastNotified": "2020-04-09T20:21:00Z",
10    "links": [],
11    "status": "OPEN",
12    "tags": [],
13    "typeName": "AGENT",
14    "updated": "2019-11-29T20:26:30Z"
15  },
16  {
17    "alertConfigId": "{ALERT-CONFIG-ID}",
18    "created": "2019-11-29T20:43:00Z",
19    "eventTypeName": "BACKUP_AGENT_DOWN",
20    "groupId": "{PROJECT-ID}",
21    "id": "{ALERT-ID}",
22    "lastNotified": "2020-04-09T20:21:54Z",
23    "links": [],
24    "status": "OPEN",
25    "tags": [],
26    "typeName": "AGENT",
27    "updated": "2019-11-29T20:43:00Z"
28  },
29  {
30    "alertConfigId": "{ALERT-CONFIG-ID}",
31    "created": "2019-11-30T12:27:07Z",
32    "eventTypeName": "BACKUP_AGENT_DOWN",
33    "groupId": "{PROJECT-ID}",
34    "id": "{ALERT-ID}",
35    "lastNotified": "2020-04-09T20:20:33Z",
36    "links": [],
37    "status": "OPEN",
38    "tags": [],
39    "typeName": "AGENT",
40    "updated": "2019-11-30T12:27:07Z"
41  }
42  ],
43  "totalCount": 3
44}

Voltar

Obter todas as configurações de alerta globais

Próximo

Obter uma configuração de alerta global