Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/ / / /

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

Recupere uma configuração de alerta global identificada por seu GLOBAL-ALERT-CONFIG-ID.

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

  • Global Owner

  • Global Monitoring Admin

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

GET /globalAlertConfigs/{GLOBAL-ALERT-CONFIG-ID}
Nome
Tipo
necessidade
Descrição
{GLOBAL-ALERT-CONFIG-ID}
string
Obrigatório
Identificador exclusivo da configuração de alerta global que você deseja recuperar.
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
content
Corpo de resposta esperado
false

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

Nome
Tipo
Descrição
created
string
Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando a configuração de alerta foi criada.
enabled
booleano
Alternar que especifica se a configuração de alerta está habilitada.
eventTypeName
string

Tipo de evento para o qual esta configuração de alerta Atlas Triggers um 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.

forAllGroups
booleano

Alternar que especifica se a configuração de alerta global se aplica a todos os grupos. Também afeta se você pode usar a array tags para direcionar a configuração para grupos específicos.

Se true, a configuração se aplica a todos os grupos. Você pode direcionar a configuração de alerta para grupos específicos através da matriz tags .

Se false, a configuração se aplica somente aos grupos especificados na array groupIds . Você deve especificar pelo menos um projeto na array groupIds . Você não pode usar a array tags para essa configuração de alerta.

groupIds
array de strings
IDs dos grupos aos quais essa configuração de alerta se aplica. Este campo se aplica somente se forAllGroups estiver definido como false.
id
string
Identificador único da configuração do alerta.
matchers
Array de objetos

Regras a serem aplicadas ao combinar um objeto com esta configuração de alerta global. MongoDB Ops Manager verifica apenas entidades que correspondem a todas essas regras para uma condição de alerta.

Você pode filtrar usando a array matchers somente quando o eventTypeName especifica um evento para um host, conjunto de réplicas ou cluster fragmentado.

matchers.fieldName
string

Nome do campo no objeto de destino ao qual corresponder.

  • Os alertas do host oferecem suporte aos seguintes campos:

    • HOSTNAME

    • PORT

    • HOSTNAME_AND_PORT

    • REPLICA_SET_NAME

    • TYPE_NAME

  • Os alertas de conjunto de réplicas suportam estes campos:

    • REPLICA_SET_NAME

    • SHARD_NAME

    • CLUSTER_NAME

  • Os alertas de cluster fragmentados suportam estes campos:

    • CLUSTER_NAME

    • SHARD_NAME

Todos os outros tipos de alertas não suportam correspondedores.

matchers.operator
string

Operador para testar o valor do campo. Os valores possíveis são:

  • EQUALS

  • NOT_EQUALS

  • CONTAINS

  • NOT_CONTAINS

  • STARTS_WITH

  • ENDS_WITH

  • REGEX

matchers.value
string

Valor para testar com o operador especificado.

Se matchers.fieldName estiver definido como TYPE_NAME, você poderá corresponder nos seguintes valores:

  • PRIMARY

  • SECONDARY

  • STANDALONE

  • CONFIG

  • MONGOS

metricThreshold
objeto
Limite que faz com que essa configuração de alerta trigger um alerta. Somente presente se eventTypeName estiver definido como OUTSIDE_METRIC_THRESHOLD.
metricThreshold.metricName
string
Nome da métrica a ser verificada. Suporta os mesmos valores que o campo metricName do recurso globalAlerts . Para obter uma lista de valores possíveis, consulte Tipos de medição para alertas globais.
metricThreshold.mode
string
É definido como AVERAGE e calcula o valor da métrica atual como uma média.
metricThreshold.operator
string

Operador para aplicar ao verificar o valor da métrica atual em relação a metricThreshold.threshold. Os valores possíveis são:

  • GREATER_THAN

  • LESS_THAN

metricThreshold.threshold
número
Valor limite fora do qual essa configuração de alerta Atlas Triggers um alerta.
metricThreshold.units
string

Unidades para metricThreshold.threshold. 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.

notifications
Array de objetos
Notificações que o MongoDB Ops Manager envia quando detecta um alerta descrito por esta configuração de alerta.
notifications.apiToken
string

Token de API do Slack ou token de Bot. Presente apenas para SLACK notificações. Se, posteriormente, o token se tornar inválido, o MongoDB Ops Manager enviará um e-mail ao proprietário do projeto e removerá o token.

Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:

  • Visualize ou edite o alerta por meio da UI.

  • Consulte as configurações de integração de terceiros por meio da API.

notifications.channelName
string
Nome do canal do Slack. Presente apenas para SLACK notificações.
notifications.delayMin
número
Número de minutos de espera depois que uma condição de alerta é detectada antes que o MongoDB Ops Manager envie a primeira notificação.
notifications.emailAddress
string
Endereço de e-mail para o qual enviar a notificação. Presente apenas para EMAIL notificações.
notifications.emailEnabled
booleano
Alterne especificando se MongoDB Ops Manager envia notificações por e-mail. Presente apenas para notificações GROUP e USER .
notifications.intervalMin
número
Número de minutos de espera entre notificações sucessivas para alertas não reconhecidos e não resolvidos que esta configuração de alerta Atlas Triggers.
notifications.[n]
.webhookSecret
string

Um valor usado para autenticar com o webhook que aceita e encaminha a notificação.

O Ops Manager retorna esse valor se você definir notifications.[n].typeName como WEBHOOK e se:

  • Você definiu notification.[n].webhookSecret como uma string não vazia

  • Você define um webhookSecret padrão no Console do administrador.

Depois de criar uma notificação de webhook, o URL é parcialmente redigido quando você visualiza ou edita o alerta, e o segredo é totalmente redigido.

notifications.[n]
.webhookUrl
string

URL do webhook que Atlas Triggers essa notificação.

O Ops Manager retorna esse valor se você definir notifications.[n].typeName como WEBHOOK e se:

  • Você definiu notification.[n].webhookURL como uma string não vazia

  • Você define um webhookUrl padrão na página Console do administrador.

Depois de criar uma notificação de webhook, o URL é parcialmente redigido quando você visualiza ou edita o alerta, e o segredo é totalmente redigido.

notifications.microsoftTeamsWebhookUrl
string

URL do webhook de entrada do canal do Microsoft Teams. Presente apenas para MICROSOFT_TEAMS notificações.

Quando você exibe ou edita o alerta de uma notificação de webhook, o URL aparece parcialmente redigido, e o segredo aparece completamente redigido.

notifications.notificationToken
string

Token da API do HipChat. Presente apenas para HIP_CHAT notificações. Se, posteriormente, o token se tornar inválido, o MongoDB Ops Manager enviará um e-mail ao proprietário do projeto e removerá o token.

Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:

  • Visualize ou edite o alerta por meio da UI.

  • Consulte as configurações de integração de terceiros por meio da API.

notifications.roomName
string
Nome da sala do HipChat. Presente apenas para HIP_CHAT notificações.
notifications.serviceKey
string

Chave de integração PagerDuty. Presente apenas para PAGER_DUTY notificações. Se a chave posteriormente se tornar inválida, o MongoDB Ops Manager enviará um e-mail ao proprietário do projeto e removerá a chave.

Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:

  • Visualize ou edite o alerta por meio da UI.

  • Consulte as configurações de integração de terceiros por meio da API.

notifications.smsEnabled
booleano
Alterne a especificação se o MongoDB Ops Manager envia notificações por SMS. Presente apenas para notificações GROUP e USER .
notifications.typeName
string

Tipo de notificação de alerta que esta configuração de alerta Atlas Triggers. Os valores possíveis são:

  • ADMIN

  • GROUP

  • USER

  • EMAIL

  • SMS (Disponível somente se o MongoDB Ops Manager estiver configurado para integração com o Twilio.)

  • HIPCHAT

  • SLACK

  • PAGER_DUTY

notifications.username
string
Nome do usuário do MongoDB Ops Manager para quem enviar notificações. Presente apenas para USER notificações.
threshold
objeto

Limite que faz com que essa configuração de alerta trigger um alerta. Somente presente se eventTypeName estiver definido para um dos seguintes valores:

  • TOO_FEW_HEALTHY_MEMBERS

  • TOO_MANY_UNHEALTHY_MEMBERS

threshold.operator
string

Operador para aplicar ao verificar o valor da métrica atual em relação a threshold.threshold. Os valores possíveis são:

  • GREATER_THAN

  • LESS_THAN

threshold.threshold
número
Valor limite fora do qual essa configuração de alerta Atlas Triggers um alerta.
tags
array de strings
Tags associadas a esta configuração de 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 esta configuração de alerta foi atualizada pela última vez.
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}"
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}
1{
2 "created": "2019-10-02T12:34:04Z",
3 "enabled": true,
4 "eventTypeName": "BACKUP_AGENT_DOWN",
5 "forAllGroups": true,
6 "groupIds": [],
7 "id": "{GLOBAL-ALERT-CONFIG-ID}",
8 "links": [
9 ],
10 "matchers": [],
11 "notifications": [
12 {
13 "delayMin": 0,
14 "intervalMin": 60,
15 "typeName": "ADMIN"
16 }
17 ],
18 "tags": [],
19 "typeName": "AGENT",
20 "updated": "2019-10-02T12:34:04Z"
21}

Voltar

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