Obter todas as configurações de alerta para um projeto

Nesta página

Resource

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

O MongoDB Ops Manager v6.0 será EOL em janeiro 2025. Atualize para uma versão superior do MongoDB Ops Manager o mais rápido possível.

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

Resource

GET /groups/{PROJECT-ID}/alertConfigs

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.

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	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 incorporado`results` .
`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 é uma configuração de alerta.

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	booleano	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.
matchers .[n].fieldName	string	Nome do campo no objeto de destino ao qual você queria que essa configuração correspondesse.
matchers .[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` .
matchers .[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.
notifications.[n] .apiToken	string	Token de token da API do Slack. O Ops Manager retorna esse valor se você definir `notifications.[n].typeName` como `SLACK` . 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.[n] .channelName	string	Nome do canal do Slack. O Ops Manager retorna esse valor se você definir `notifications.[n].typeName` como `SLACK` .
notifications.[n] .datadogApiKey	string	Chave API DataDog. O Ops Manager retorna esse valor se você definir `notifications.[n].typeName` como `DATADOG` . 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.[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.
notifications.[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` .
notifications.[n] .emailEnabled	booleano	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`.
notifications.[n] .intervalMin	número	Número de minutos para aguardar entre notificações sucessivas para alertas não confirmados que não foram resolvidos.
notifications.[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` . 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.[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` .
notifications.[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 posteriormente se tornar inválido, o MongoDB Atlas enviará um e-mail para `Project Owner` 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.[n] .opsGenieApiKey	string	API de alerta OpsGenie chave. MongoDB Ops Manager retorna esse valor se você definir `notifications.[n].typeName` como `OPS_GENIE`. 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.[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`.
notifications.[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`.
notifications.[n] .roomName	string	Nome da divisão do HipChat. O Ops Manager retorna esse valor se `"notifications.typeName" : "HIP_CHAT`.
notifications.[n] .serviceKey	string	Chave de serviço PagerDuty. O Ops Manager retorna esse valor se você definir `notifications.[n].typeName` como `PAGER_DUTY` . 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.[n] .smsEnabled	booleano	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`.
notifications.[n] .snmpAddress	string	Nome do host e porta para os quais enviar capturas SNMP . No momento, o MongoDB Ops Manager só pode enviar capturas SNMP para a porta SNMP padrão (162). Preenchido para notificações de `SNMP` . MongoDB Ops Manager usa SNMP v2c. Importante MongoDB Ops Manager 6.0.0 descontinua alertas SNMP . MongoDB Ops Manager 7.0.0 não incluirá alertas de SNMP . Para saber mais sobre outras opções de alerta , consulte Integrações de serviços de terceiros.
notifications.[n] .teamId	string	Identificador único da equipe que recebe esta notificação.
notifications.[n] .teamName	string	Etiqueta para a equipe que recebe esta notificação.
notifications.[n] .typeName	string	Significa pelo qual você deseja que o Ops Manager envie a você a notificação de um alerta.
notifications.[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` .
notifications.[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`. 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.[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`.
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 padrão `webhookSecret` na página Integrações ou com a API de Integrações 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 padrão `webhookUrl` na página Integrações ou com a API de Integrações Depois de criar uma notificação de webhook, o URL é parcialmente redigido quando você visualiza ou edita o alerta, e o segredo é totalmente 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`.
threshold .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.
threshold .threshold	número	Valor que, quando excedido, o Ops Manager aciona um alerta.
threshold .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"

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

{
  "links" : [],
  "results": [ {
    "created" : "2013-10-30T15:28:30Z",
    "enabled" : true,
    "eventTypeName" : "RESYNC_REQUIRED",
    "groupId" : "{PROJECT-ID}",
    "id" : "5271259ee4b00ece6b4754ef",
    "links" : [],
    "matchers" : [ ],
    "notifications" : [ {
      "delayMin" : 0,
      "emailAddress" : "somebody@example.com",
      "intervalMin" : 60,
      "typeName" : "EMAIL"
    } ],
    "updated" : "2014-02-12T16:11:05Z"
  }, {
    "created" : "2014-03-19T16:42:07Z",
    "enabled" : true,
    "eventTypeName" : "MONITORING_AGENT_DOWN",
    "groupId" : "{PROJECT-ID}",
    "id" : "5329c8dfe4b0b07a83d67e7e",
    "links" : [],
    "matchers" : [ ],
    "notifications" : [ {
      "delayMin" : 0,
      "emailEnabled" : true,
      "intervalMin" : 5,
      "smsEnabled" : false,
      "typeName" : "GROUP"
    } ],
    "updated" : "2014-03-19T16:42:07Z"
  }, {
    "created" : "2014-04-03T20:26:50Z",
    "enabled" : true,
    "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
    "groupId" : "{PROJECT-ID}",
    "id" : "533dc40ae4b00835ff81eaee",
    "links" : [],
    "matchers" : [ {
      "field" : "hostnameAndPort",
      "operator" : "EQUALS",
      "value" : "mongo.example.com:27017"
    } ],
    "notifications" : [ {
      "delayMin" : 0,
      "intervalMin" : 5,
      "mobileNumber" : "2343454567",
      "typeName" : "SMS"
    } ],
    "metricThreshold" : {
      "metricName" : "ASSERT_REGULAR",
      "mode" : "AVERAGE",
      "operator" : "LESS_THAN",
      "threshold" : 99.0,
      "units" : "RAW"
    },
    "updated" : "2014-04-03T20:26:50Z",
  } ],
  "totalCount": 3
}

Voltar

Obtenha todos os nomes de campo dos correspondentes de configuração de alertas

Criar uma configuração de alerta

Observação

Resource

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

Observação

Importante

Exemplo de solicitação

Exemplo de resposta

Cabeçalho de resposta

Corpo de resposta

`results` documento incorporado