Menu Docs

Página inicial do Docs → MongoDB Ops Manager

Obter uma configuração de alerta

Nesta página

  • Recurso
  • 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

Observação

Grupos e projetos são termos sinônimos. Seu {PROJECT-ID} é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. Esta página usa o grupo de termos mais conhecido ao se referir às descrições. O ponto final permanece conforme indicado no documento.

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

Recurso

GET /groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}

Parâmetros do caminho da solicitação

Todos os parâmetros do caminho da solicitação são obrigatórios.

Parâmetro
Tipo
Descrição
ID do projeto
string
Identificador único para este projeto.
alerta-CONFIG-ID
string
Identificador exclusivo para esta configuração de alerta.

Solicitar parâmetros de query

Os seguintes parâmetros de query são opcionais:

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
boleano
Opcional
Sinalizador que indica se o corpo da resposta deve estar em um prettyprint formato.
false
envelope
boleano
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
boleano
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

Observação

As configurações de alerta variam. Uma configuração de alerta pode incluir somente um subconjunto desses elementos.

Nome
Tipo
Descrição
Criado
string
Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando essa configuração de alerta foi criada.
habilitado
boleano
Sinalizador que indica esta configuração de alerta habilitada.
eventTypeName
string
Tipo de evento que Atlas Triggers um alerta.
groupId
string
Identificador único do projeto que possui esta configuração de alerta.
id
string
Identificador único da configuração do alerta.
links
Array de objetos

Um ou mais links para sub-recursos e/ou recursos relacionados. Os tipos de relação entre URLs são explicados na Especificação de links da web .

correspondedores
Array de objetos
Regras a serem aplicadas ao corresponder um objeto a essa configuração de alerta.
correspondedores
.[n].fieldName
string
Nome do campo no objeto de destino ao qual você queria que essa configuração correspondesse.
correspondedores
.[n].operator
string
Operador de comparação a ser aplicado ao verificar o valor da métrica atual em relação a matcher.[n].value .
correspondedores
.[n].value
string
Valor para corresponder ou exceder usando matchers.[n].operator .
metricThreshold
objeto
Valor e meios de comparação que Atlas Triggers um alerta.
metricThreshold
.metricName
string
Nome da métrica a ser verificada. Suporta os mesmos valores que o campo metricName do recurso alerts .
metricThreshold
.mode
string
Valor médio desta métrica.
metricThreshold
.operator
string
Operador de comparação que o Ops Manager aplicou ao verificar o valor da métrica atual em relação ao valor limite.
metricThreshold
.threshold
número
Valor de metricThreshold.metricName que, quando excedido, Atlas Triggers um alerta.
metricThreshold
.units
string
Unidades de capacidade ou tempo que definem o escopo do metricThreshold.threshold.
notificações
Array de objetos
Um ou mais destinos para o Ops Manager enviar notificações quando uma condição de alerta for detectada.
notificações.[n]
.apiToken
string

Token de token da API do Slack. O Ops Manager retorna esse valor se você definir notifications.[n].typeName como SLACK .

Observação

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.

notificações.[n]
.channelName
string
Nome do canal do Slack. O Ops Manager retorna esse valor se você definir notifications.[n].typeName como SLACK .
notificações.[n]
.datadogApiKey
string

Chave API DataDog. O Ops Manager retorna esse valor se você definir notifications.[n].typeName como DATADOG .

Observação

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.

notificações.[n]
.delayMin
número
Número de minutos para aguardar após uma condição de alerta ser detectada antes de enviar a primeira notificação.
notificações.[n]
.emailAddress
string
Endereço de e-mail para o qual enviar a notificação. O Ops Manager retorna esse valor se você definir notifications.[n].typeName como EMAIL .
notificações.[n]
.emailEnabled
boleano
Sinalizador indicando que as notificações por e-mail devem ser enviadas. O Ops Manager retorna esse valor se você definir notifications.[n].typeName como ORG, GROUP ou USER.
notificações.[n]
.intervalMin
número
Número de minutos para aguardar entre notificações sucessivas para alertas não confirmados que não foram resolvidos.
notificações.[n]
.microsoftTeamsWebhookUrl
string

URL do webhook de entrada do canal do Microsoft Teams. O Ops Manager retorna esse valor se você definir notifications.[n].typeName como MICROSOFT_TEAMS .

Observação

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

notificações.[n]
. mobileNumber
string
Número de celular para o qual as notificações de alerta são enviadas. O Ops Manager retorna esse valor se você definir notifications.[n].typeName como SMS .
notificações.[n]
.notificationToken
string

Token de API do HipChat. O Ops Manager retorna esse valor se você definir notifications.[n].typeName como HIP_CHAT .

Se o token se tornar inválido posteriormente, o MongoDB Atlas enviará um e-mail para o Project Owner e eventualmente removerá o token.

Observação

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.

notificações.[n]
.opsGenieApiKey
string

API de alerta OpsGenie chave. O Ops Manager retorna esse valor se você definir notifications.[n].typeName como OPS_GENIE.

Observação

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.

notificações.[n]
.opsGenieRegion
string
Região que indica qual URL da API usar. O Ops Manager retorna esse valor se você definir notifications.[n].typeName como OPS_GENIE.
notificações.[n]
.roles
array de strings
Função de Ops Manager no projeto ou organização atual. O Ops Manager retornará esse valor se você definir notifications.[n].typeName como ORG ou GROUP.
notificações.[n]
.roomName
string
Nome da divisão do HipChat. O Ops Manager retorna esse valor se "notifications.typeName" : "HIP_CHAT.
notificações.[n]
.serviceKey
string

Chave de serviço PagerDuty. O Ops Manager retorna esse valor se você definir notifications.[n].typeName como PAGER_DUTY .

Observação

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.

notificações.[n]
.smsEnabled
boleano
O sinalizador indicando que as notificações de texto devem ser enviadas. O Ops Manager retorna esse valor se você definir notifications.[n].typeName como ORG, GROUP ou USER.
notificações.[n]
.snmpAddress
string

Nome do host e porta para os quais enviar capturas SNMP . No momento, o Ops Manager só pode enviar capturas SNMP para a porta SNMP padrão (162). Preenchido para notificações de SNMP . O Ops Manager usa SNMP v2c.

Importante

Ops Manager 6.0.0 descontinua alerta SNMP. Ops Manager 7.0.0 não incluirá alerta SNMP. Para saber mais sobre outras opções de alerta, consulte Integrações de serviços de terceiros.

notificações.[n]
.teamId
string
Identificador único da equipe que recebe esta notificação.
notificações.[n]
.teamName
string
Etiqueta para a equipe que recebe esta notificação.
notificações.[n]
.typeName
string
Significa pelo qual você deseja que o Ops Manager envie a você a notificação de um alerta.
notificações.[n]
.username
string
Nome de um usuário do Ops Manager para o qual enviar notificações. O Ops Manager retorna esse valor se você definir notifications.[n].typeName como USER .
notificações.[n]
.victorOpsApiKey
string

Chave de API VictorOps.

Se a chave se tornar inválida posteriormente, o MongoDB Atlas enviará um e-mail para o Project Owner e eventualmente removerá a chave.

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

Observação

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.

notificações.[n]
.victorOpsRoutingKey
string

Chave de roteamento VictorOps.

Se a chave se tornar inválida posteriormente, o MongoDB Atlas enviará um e-mail para o Project Owner e eventualmente removerá a chave.

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

notificações.[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:

Observação

Depois de criar uma notificação de webhook, o URL aparecerá parcialmente redigido quando você visualizar ou editar o alerta, e o segredo aparecerá completamente redigido.

notificações.[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:

Observação

Depois de criar uma notificação de webhook, o URL aparecerá parcialmente redigido quando você visualizar ou editar o alerta, e o segredo aparecerá completamente redigido.

limite
objeto
Limite que Atlas Triggers um alerta. O Ops Manager retorna esse valor se eventTypeName for qualquer valor diferente de OUTSIDE_METRIC_THRESHOLD.
limite
.operator
string
Operador de comparação que o Ops Manager aplicou ao verificar o valor da métrica atual em relação ao valor limite.
limite
.threshold
número
Valor que, quando excedido, o Ops Manager aciona um alerta.
limite
.units
string
Unidades de capacidade ou tempo que definem o escopo do threshold.threshold.
typeName
string
Este campo é preterido e é ignorado.
Atualizado
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.

Exemplo de solicitação

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}"

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

{
  "created" : "2014-04-03T20:26:50Z",
  "enabled" : true,
  "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
  "groupId" : "{PROJECT-ID}",
  "id" : "{ALERT-CONFIG-ID}",
  "matchers" : [ {
    "field" : "hostnameAndPort",
    "operator" : "EQUALS",
    "value" : "mongo.example.com:27017"
  } ],
  "links" : [],
  "metricThreshold" : {
    "metricName" : "ASSERT_REGULAR",
    "mode" : "AVERAGE",
    "operator" : "LESS_THAN",
    "threshold" : 99.0,
    "units" : "RAW"
  },
  "notifications" : [ {
    "delayMin" : 0,
    "intervalMin" : 5,
    "mobileNumber" : "2343454567",
    "typeName" : "SMS"
  } ],
  "updated" : "2014-04-03T20:26:50Z"
}
← Criar uma configuração de alerta
Atualizar uma configuração de alerta →

Nesta página