Obter 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

O Cloud Manager não oferecerá mais suporte para Automação, Backup e Monitoramento do MongoDB 3.6 e 4.0 após 30 de agosto de 2024. Faça upgrade da sua versão do MongoDB ou migre para o Atlas.

A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.: O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .

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

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	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 `content` é um envelope. O Cloud 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

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: 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. Cloud 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 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' \
     --include \
     --request GET "https://cloud.mongodb.com/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"
}

Voltar

criar

Update