atualização das configurações de alerta do Atlas

Nesta página

Sintaxe

argumentos
Opções
Opções herdadas
Saída
Exemplos

Modifique os detalhes da configuração de alerta especificada para seu projeto.

Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a role de proprietário do projeto.

Sintaxe

Sintaxe do comando

atlas alerts settings update <alertConfigId> [options]

argumentos

Nome	Tipo	Obrigatório	Descrição
alertConfigId	string	true	Identificador exclusivo da configuração de alerta que você deseja atualizar.

Opções

Nome	Tipo	Obrigatório	Descrição
--apiKey	string	false	Chave de API Datadog, chave de API Opsgenie ou chave de API VictorOps. Obrigatório se o notificationType for DATADOG, OPS_GENIE ou VICTOR_OPS, respectivamente.
--enabled		false	Sinalizador que indica se a configuração de alerta deve ser habilitada.
--event	string	false	Tipo de evento que acionou o alerta. Para saber quais valores a CLI aceita, consulte o Enum para eventTypeName na especificação da API do Atlas Admin: https://dochub.mongodb.org/core/atlas-event-names.
-f, --file	string	false	Caminho para o arquivo de configuração JSON que define as definições de configuração de alerta. Para saber mais sobre arquivos de configuração de alerta para Atlas CLI, consulte https://dochub.mongodb.org/core/alert-config-atlas-cli.
-h, --help		false	ajuda para atualização
--matcherFieldName	string	false	Nome do campo no objeto de destino a ser correspondido. Para saber os valores válidos, execute o tipo de campo de configurações de alerta do Atlas.
--matcherOperator	string	false	Operador de comparação a ser aplicado ao verificar a métrica atual em relação amatcherValue. Os valores válidos são Contains, Ends_WITH, Equals, not_contains, not_equals, regex, StartS_WITH.
--matcherValue	string	false	Valor para testar com o operador especificado. Se o matcherFieldName for definido como TYPE_NAME, você poderá fazer a correspondência com os seguintes valores: CONFIG, Mongo, PRIMARY, SECONDARY, autônomo.
--metricMode	string	false	Opção que indica se o Atlas calcula o valor da métrica atual como uma média. O valor válido é AVERAGE.
--metricName	string	false	Nome da métrica em relação à qual este comando verifica o alerta configurado. Para saber os valores válidos, consulte https://dochub.mongodb.org/core/alert-host-metrics-atlas. Esta opção se aplica somente se o evento estiver definido comoOUTSIDE_METRIC_THRESHOLD.
--metricOperator	string	false	Operador de comparação a ser aplicado ao verificar o valor da métrica atual. Os valores válidos são LESS_TANA e GREATER_TANA.
--metricThreshold	flutuar	false	Valor limite fora do qual um alerta será acionado.
--metricUnits	string	false	Unidades para o valor limite. Os valores válidos são BITS, BYTES, DAYS, GIGABITS, GIGABYTES, HOURS, KILOBITS, KILOBYTES, MUSEBITS, MEABYTES, MILLISECONDS, MINUTES, petabytes, CRW, SECONDS, TERABYTES.
--notificationChannelName	string	false	Nome do canal do Slack. Necessário para o tipo de notificações Slack.
--notificationDelayMin	int	false	Número de minutos para aguardar após uma condição de alerta ser detectada antes de enviar a primeira notificação.
--notificationEmailAddress	string	false	Endereço de e-mail para o qual as notificações de alerta são enviadas.
--notificationEmailEnabled		false	Sinalizador que habilita notificações por e-mail. Configurável para tipos de notificação GRUPO e USUÁRIO.
--notificationIntervalMin	int	false	Número de minutos para aguardar entre notificações sucessivas para alertas não confirmados que não foram resolvidos.
--notificationMobileNumber	string	false	Número de celular para o qual as notificações de alerta são enviadas.
--notificationRegion	string	false	Região que indica qual URL da API usar.
--notificationRole	strings	false	Lista que contém uma ou mais roles da organização ou do projeto que recebem o alerta configurado.
--notificationServiceKey	string	false	Chave de serviço PagerDuty.
--notificationSmsEnabled		false	Sinalizador que habilita as notificações de mensagens de texto.
--notificationTeamId	string	false	Identificador único de uma equipe.
--notificationToken	string	false	Token de API do Slack ou token de Bot.
--notificationType	string	false	Tipo de notificação de alerta. Os valores válidos são DATADOG, E-mail, GROUP (Project), Microsoft, ORG, OPS_GENIE, PAGER_DUTY, Slack, SMS, equipe, USER, VICTOR_OPS ou WEBHOOK.
--notificationUsername	string	false	Nome do Atlas user para o qual enviar notificações.
--notificationVictorOpsRoutingKey	string	false	Chave de roteamento associada à sua conta Splunk On-Call.
--notificationWebhookSecret	string	false	Segredo de autenticação para um alerta baseado em webhook.
--notificationWebhookUrl	string	false	URL de destino para um alerta baseado em webhook ou alerta da equipe Microsoft.
--notifierId	string	false	Identificador exclusivo gerado pelo sistema atribuído a cada método de notificação. Esse identificador é necessário ao atualizar notificações de terceiros sem exigir credenciais de autenticação explícitas.
-o, --output	string	false	Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON.
--projectId	string	false	String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente.

Opções herdadas

Nome	Tipo	Obrigatório	Descrição
-P, --profile	string	false	Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Saída

Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.

Alert configuration '<Id>' updated.

Exemplos

# Modify the alert configuration with the ID 5d1113b25a115342acc2d1aa so that it notifies a user when they join a group for the project with the ID 5df90590f10fab5e33de2305:
atlas alerts settings update 5d1113b25a115342acc2d1aa --event JOINED_GROUP --enabled \
             --notificationType USER --notificationEmailEnabled \
             --notificationIntervalMin 60 --notificationUsername john@example.com \
             --output json --projectId 5df90590f10fab5e33de2305

# Update alert using json file input containing alert configuration
atlas alerts settings update 5d1113b25a115342acc2d1aa --file alerts.json

Voltar

Lista

não reconhecer