Menu Docs
Página inicial do Docs
/
MongoDB Cloud Manager
/
API
/
Recursos
/
Medições e alertas
/
Configurações de alerta

Criar uma configuração de alerta

Nesta página

  • Resource
  • 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://cloud.mongodb.com/api/public/v1.0

Resource

POST /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

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

Parâmetros do corpo da solicitação

Observação

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

Nome
Tipo
Descrição

habilitado

booleano

Se omitido, a configuração será desabilitada.

eventTypeName
Required

string

O tipo de evento que Atlas Triggers um alerta.

Os valores incluem:

Agente

Configuração da automação

Backup.

BI Connector

Cobrança

cluster

Data Explorer acessado

Backup em disco

Anfitrião

Organização

Projeto

Conjunto de réplicas

Caso de suporte

team

Usuário

Para ver a lista completa de eventos que geram alertas e suas descrições, consulte Tipos de alerta.

correspondências.fieldName

string

Nome do campo no objeto de destino a ser correspondido.

  • 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 aceitos são:

  • EQUALS

  • NOT_EQUALS

  • CONTAINS

  • NOT_CONTAINS

  • STARTS_WITH

  • ENDS_WITH

  • REGEX

correspondente.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

correspondedores

array de objetos

Regras a serem aplicadas ao corresponder um objeto a essa configuração de alerta. Somente entidades que correspondem a todas essas regras são verificadas quanto a 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.

metricThreshold.metricName

string

Nome da métrica a ser verificada. Suporta os mesmos valores que o campo metricName do recurso alerts .

metricThreshold.mode

string

Defina como AVERAGE para calcular a média dessa métrica.

metricThreshold.operator

string

Operador a ser aplicado ao verificar o valor da métrica atual em relação ao valor limite. Os valores aceitos são:

  • GREATER_THAN

  • LESS_THAN

metricThreshold.threshold

número

Valor limite fora do qual um alerta é acionado.

metricThreshold.units

string

Unidades para o valor limite. Depende do tipo de métrica.

Por exemplo, uma métrica que mede o consumo de memória teria uma medida de bytes, enquanto uma métrica que mede o tempo teria uma unidade de tempo.

Os valores aceitos são:

  • RAW

  • BITS

  • BYTES

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • GIGABITS

  • GIGABYTES

  • TERABYTES

  • PETABYTES

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

metricThreshold

objeto

Limite que fará com que um alerta seja acionado. Necessário se "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD".

notifications.apiToken

string

Token de API do Slack ou token de Bot. Obrigatório se "notifications.typeName" : "SLACK". Se o token posteriormente se tornar inválido, o Cloud 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. Necessário se "notifications.typeName" : "SLACK".

notifications.datadogApiKey

string

Chave API DataDog. Encontrado no painel do DataDog. Necessário se "notifications.typeName" : "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.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.emailAddress

string

Endereço de e-mail para o qual enviar a notificação. Necessário se "notifications.typeName" : "EMAIL".

notifications.emailEnabled

booleano

Determina se as notificações por e-mail devem ser enviadas. Necessário se:

  • "notifications.typeName" : "GROUP"

  • "notifications.typeName" : "USER"

notifications.intervalMin

número

Número de minutos para aguardar entre notificações sucessivas para alertas não confirmados que não foram resolvidos.

notifications.webhookSecret

string

Um valor usado para autenticar com o webhook que aceita e encaminha a notificação. Você pode declarar explicitamente um segredo somente em uma solicitação que tenha ambos:

  • Um notifications.typeName de WEBHOOK

  • Uma declaração explicitamente notifications.webhookURL

Você pode configurar um webhookSecret para um webhookURL padrão somente na página Integrações ou com a API de Integrações.

Para declarar explicitamente um webhookURL sem um webhookSecret, omita este campo.

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.webhookUrl

string

URL do webhook que Atlas Triggers essa notificação. Se você não declarar explicitamente um webhookUrl, sua solicitação usará o webhookUrl padrão definido 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.microsoftTeamsWebhookUrl

string

URL do webhook de entrada do canal do Microsoft Teams. Necessário se "notifications.typeName" : "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. mobileNumber

string

Número de celular para enviar mensagens SMS. Necessário se "notifications.typeName" : "SMS".

notifications.notificationToken

string

Um token de API do HipChat. Obrigatório se "notifications.typeName" : "HIP_CHAT". Se o token posteriormente se tornar inválido, o Cloud 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.role

string

Uma ou mais funções de projeto que recebem o alerta configurado . Os valores aceitos incluem:

Valor da função na API
Função

GROUP_AUTOMATION_ADMIN

Project Automation Admin

GROUP_BACKUP_ADMIN

Project Backup Admin

GROUP_BILLING_ADMIN

Administrador de faturamento do projeto

GROUP_DATA_ACCESS_ADMIN

Project Data Access Admin

GROUP_DATA_ACCESS_READ_ONLY

Project Data Access Read Only

GROUP_DATA_ACCESS_READ_WRITE

Project Data Access Read/Write

GROUP_MONITORING_ADMIN

Project Monitoring Admin

GROUP_OWNER

Project Owner

GROUP_READ_ONLY

Project Read Only

GROUP_USER_ADMIN

Project User Admin

Se você incluir esse campo, o Cloud Manager enviará alertas somente para os usuários atribuídos às funções especificadas na array. Se você omitir este campo, o Cloud Manager enviará alertas para usuários atribuídos a qualquer função.

Configurável para GROUP tipos de notificações.

notifications.roomName

string

Nome da divisão do HipChat. Necessário se "notifications.typeName" : "HIP_CHAT".

notifications.serviceKey

string

Chave de integração PagerDuty. Necessário se "notifications.typeName" : "PAGER_DUTY".

notifications.smsEnabled

booleano

Sinalizador que indica que as notificações por SMS devem ser enviadas. Necessário se:

  • "notifications.typeName" : "GROUP"

  • "notifications.typeName" : "USER"

notifications.teamId

string

Identificador único de uma equipe.

notifications.typeName

string

Tipo de notificação de alerta. Os valores aceitos são:

  • EMAIL

  • GROUP (projeto)

  • HIPCHAT

  • ORG

  • PAGER_DUTY

  • SLACK

  • SMS

  • TEAM

  • USER

  • WEBHOOK

  • MICROSOFT_TEAMS

notifications.username

string

Nome de um usuário do Cloud Manager para o qual enviar notificações. Especifique um usuário no projeto que possui a configuração de alerta. Obrigatório se "notifications.typeName" : "USER".

notifications
Required

array de objetos

Notificações para enviar quando uma condição de alerta for detectada.

limite.operador

string

Operador a ser aplicado ao verificar o valor da métrica atual em relação ao valor limite.

  • GREATER_THAN

  • LESS_THAN

limite.threshold

número

Valor limite fora do qual um alerta é acionado.

limite

objeto

Limite que fará com que um alerta seja acionado. Necessário se:

  • "eventTypeName" : "TOO_FEW_HEALTHY_MEMBERS"

  • "eventTypeName" : TOO_MANY_UNHEALTHY_MEMBERS

Resposta

A resposta inclui os detalhes da configuração do 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 Cloud 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 Cloud Manager enviar notificações quando uma condição de alerta for detectada.

notifications.[n]
.apiToken

string

Token de token da API do Slack. Cloud 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. Cloud Manager retorna esse valor se você definir notifications.[n].typeName como SLACK.

notifications.[n]
.datadogApiKey

string

Chave API DataDog. Cloud 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. Cloud 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 Cloud 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 da equipe Microsoft. Cloud 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 Cloud Manager retorna esse valor se você definir notifications.[n].typeName como SMS.

notifications.[n]
.notificationToken

string

Token de API do HipChat. O Cloud 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.

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. O Cloud 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. Cloud Manager retorna esse valor se você definir notifications.[n].typeName como OPS_GENIE.

notifications.[n]
.roles

array de strings

Função do Cloud Manager no projeto ou organização atual. Cloud 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 Cloud Manager retorna esse valor se "notifications.typeName" : "HIP_CHAT.

notifications.[n]
.serviceKey

string

Chave de serviço PagerDuty. Cloud 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 Cloud Manager retorna esse valor se você definir notifications.[n].typeName como ORG, GROUP ou USER.

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 Cloud Manager envie a você uma notificação de alerta.

notifications.[n]
.username

string

Nome de um usuário do Cloud Manager para o qual enviar notificações. Cloud 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.

Cloud 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.

Cloud 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]
.webhookSecret

string

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

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

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.

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

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 aciona um alerta. Cloud Manager retorna esse valor se eventTypeName for qualquer valor diferente de OUTSIDE_METRIC_THRESHOLD.

threshold
.operator

string

Operador de comparação que o Cloud Manager aplicou ao verificar o valor da métrica atual em relação ao valor limite.

threshold
.threshold

número

O valor que, quando excedido, o Cloud Manager Atlas Triggers 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" \
     --header "Content-Type: application/json" \
     --include \
     --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs" \
     --data '
       {
         "groupId" : "{PROJECT-ID}",
         "eventTypeName" : "RESYNC_REQUIRED",
         "enabled" : true,
         "notifications" : [ {
           "typeName" : "GROUP",
           "intervalMin" : 5,
           "delayMin" : 0,
           "smsEnabled" : false,
           "emailEnabled" : true
         } ]
       }'

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-23T14:29:18Z",
  "enabled" : true,
  "groupId" : "{PROJECT-ID}",
  "id" : "{ALERT-CONFIG-ID}",
  "links" : [],
  "matchers" : [ ],
  "notifications" : [ {
    "delayMin" : 0,
    "emailEnabled" : true,
    "intervalMin" : 5,
    "smsEnabled" : false,
    "typeName" : "GROUP"
  } ],
  "updated" : "2014-04-23T14:29:18Z"
}

Voltar

Obter tudo para um projeto

Próximo

Pegue um