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

Reconhecer um 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
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

Você pode confirmar um alerta até a hora e a data especificadas. Você também pode cancelar a confirmação de um alerta especificando uma data e uma hora no passado.

Funções obrigatórias

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

Solicitar

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

PATCH /globalAlerts/{ALERT-ID}

Parâmetros do caminho da solicitação

Nome
Tipo
Descrição
ALERT-ID
string
Identificador único da janela de manutenção que você deseja reconhecer.

Solicitar parâmetros de query

Nome
Tipo
necessidade
Descrição
Default
pretty
booleano
Opcional
Sinalizador indicando 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 da API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

Nome
Descrição
Status
Código de resposta HTTP
envelope
Corpo de resposta esperado
false

Parâmetros do corpo da solicitação

Parâmetro do corpo
Tipo
necessidade
Descrição
acknowledgedUntil
string
Obrigatório

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC pelo qual você conhece este alerta. Após esse tempo, o MongoDB Ops Manager reverte o alerta para não confirmado.

Para evitar que o alerta seja retomado tão cedo, defina a data e a hora para algum momento no futuro distante.

Para cancelar a confirmação de um alerta, especifique uma hora e uma data no passado.

acknowledgementComment
string
Opcional
Comentário descrevendo a confirmação do alerta.

Resposta

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     --header "Content-Type: application/json" \
4     --include \
5     --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlerts/{ALERT-ID}" \
6     --data '{
7        "acknowledgedUntil":"2020-04-10T20:21:31Z",
8        "acknowledgementComment":"test"
9       }'

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 201 Created
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  "acknowledgedUntil": "2020-04-10T20:20:38Z",
3  "acknowledgementComment": "test",
4  "acknowledgingUsername": "rwqvzark",
5  "alertConfigId": "{ALERT-CONFIG-ID}",
6  "created": "2019-12-02T20:39:54Z",
7  "eventTypeName": "BACKUP_AGENT_DOWN",
8  "groupId": "{PROJECT-ID}",
9  "id": "{ALERT-ID}",
10  "lastNotified": "2020-04-09T20:21:31Z",
11  "links": [
12  ],
13  "status": "OPEN",
14  "tags": [],
15  "typeName": "AGENT",
16  "updated": "2020-04-10T19:14:38Z"
17}

Voltar

Receba um alerta global

Próximo

Configurações de alerta global