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 termo grupo, que é mais familiar, ao se referir a descrições. O ponto de extremidade permanece conforme indicado no documento.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
PUT /groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}
Observação
Para atualizar apenas o estado ativado/desativado da configuração de alerta, consulte Ativar/desativar configuração de alertas .
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 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | booleano | Opcional | Sinalizador que indica se o corpo da resposta deve estar em um formato prettyprint. |
| ||||||
envelope | booleano | Opcional | Sinalizador que indica se deseja ou não envolver a resposta em um envelope. Alguns clientes de 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:
|
|
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 | necessidade | Descrição |
|---|---|---|---|
habilitado | booleano | Opcional | Se omitido, a configuração será desabilitada. |
eventTypeName | string | Obrigatório | O tipo de evento que Atlas Triggers um alerta. Os valores incluem: Agente Configuração da automação Backup. BI Connector cluster Data Explorer acessado Anfitrião Organização Projeto Conjunto de réplicas team Usuário Para ver a lista completa de eventos que geram alertas e suas descrições, consulte Tipos de alerta. Para obter uma lista completa de eventos incluídos no registro de auditoria do Ops Manager, consulte Eventos de auditoria. |
matchers.fieldName | string | Opcional | Nome do campo no objeto de destino a ser correspondido.
Todos os outros tipos de alertas não suportam correspondedores. |
| string | Opcional | Operador para testar o valor do campo. Os valores aceitos são:
|
matchers.value | string | Opcional | Valor para testar com o operador especificado. Se
|
correspondedores | array de objetos | Opcional | 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 |
metricThreshold | string | Opcional | Nome da métrica a ser verificada. Suporta os mesmos valores que o campo |
metricThreshold | string | Opcional | Defina como |
metricThreshold.operator | string | Opcional | Operador a ser aplicado ao verificar o valor da métrica atual em relação ao valor limite. Os valores aceitos são:
|
| número | Opcional | Valor limite fora do qual um alerta é acionado. |
metricThreshold | string | Opcional | 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:
|
metricThreshold | objeto | Condicional | Limite que fará com que um alerta seja acionado. Necessário se |
notifications.apiToken | string | Condicional | Token de API do Slack ou token de Bot. Necessário se Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
| string | Condicional | Nome do canal do Slack. Necessário se |
notifications.datadogApiKey | string | Condicional | Chave API DataDog. Encontrado no painel do DataDog. Necessário se Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
| número | Opcional | 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 | Condicional | Endereço de e-mail para o qual enviar a notificação. Necessário se |
notifications.emailEnabled | booleano | Condicional | Determina se as notificações por e-mail devem ser enviadas. Necessário se:
|
notifications.intervalMin | número | Opcional | Número de minutos para aguardar entre notificações sucessivas para alertas não confirmados que não foram resolvidos. |
| string | Opcional | 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:
Você pode configurar um Para declarar explicitamente um Depois de criar uma notificação de webhook, o URL é parcialmente redigido quando você visualiza ou edita o alerta, e o segredo é totalmente redigido. |
| string | Opcional | URL do webhook que Atlas Triggers essa notificação. Se você não declarar explicitamente um Depois de criar uma notificação de webhook, o URL é parcialmente redigido quando você visualiza ou edita o alerta, e o segredo é totalmente redigido. |
| string | Opcional | Modelo de cabeçalhos personalizados para incluir em notificações de webhook. Você pode usar variáveis no modelo que são substituídas por valores específicos de alerta quando a notificação é enviada. |
| string | Opcional | Modelo para o conteúdo do corpo das notificações de webhook. Você pode usar variáveis no modelo que são substituídas por valores específicos de alerta quando a notificação é enviada. |
| string | Condicional | URL do webhook de entrada do canal do Microsoft Teams. Necessário se Quando você exibe ou edita o alerta de uma notificação de webhook, o URL aparece parcialmente redigido, e o segredo aparece completamente redigido. |
| string | Condicional | Número de celular para enviar mensagens SMS. Necessário se |
notifications.notificationToken | string | Condicional | Um token de API do HipChat. Necessário se Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
notifications.role | string | Condicional | Função de Ops Manager no projeto atual. Necessário se |
notifications.roomName | string | Condicional | Nome da divisão do HipChat. Necessário se |
notifications.serviceKey | string | Condicional | Chave de integração PagerDuty. Necessário se Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
| booleano | Condicional | Sinalizador que indica que as notificações por SMS devem ser enviadas. Necessário se:
|
notifications.teamId | string | Opcional | Identificador único de uma equipe. |
| string | Opcional | Tipo de notificação de alerta. Os valores aceitos são:
|
| string | Condicional | Nome de um usuário do Ops Manager para o qual enviar notificações. Especifique um usuário no projeto que possui a configuração de alerta. Necessário se |
notificações | array de objetos | Obrigatório | Notificações para enviar quando uma condição de alerta for detectada. |
limite | string | Opcional | Operador a ser aplicado ao verificar o valor da métrica atual em relação ao valor limite.
|
threshold | número | Opcional | Valor limite fora do qual um alerta é acionado. |
limite | objeto | Condicional | Limite que fará com que um alerta seja acionado. Necessário se:
|
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 | Registro de data/hora no formato de data e hora ISO 8601 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. |
| string | Nome do campo no objeto de destino ao qual você queria que essa configuração correspondesse. |
| string | Operador de comparação a ser aplicado ao verificar o valor da métrica atual em relação a |
matchers | string | Valor para corresponder ou exceder usando |
metricThreshold | objeto | Valor e meios de comparação que Atlas Triggers um alerta. |
metricThreshold | string | Nome da métrica a ser verificada. Suporta os mesmos valores que o campo |
metricThreshold | 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. |
| número | Valor de |
metricThreshold | string | Unidades de capacidade ou tempo que definem o escopo do |
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] | string | Token de token da API do Slack. O Ops Manager retorna esse valor se você definir Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
notificações.[n] | string | Nome do canal do Slack. O Ops Manager retorna esse valor se você definir |
notificações.[n] | string | Chave API DataDog. O Ops Manager retorna esse valor se você definir Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
notificações.[n] | 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] | string | Endereço de e-mail para o qual enviar a notificação. O Ops Manager retorna esse valor se você definir |
notificações.[n] | booleano | Sinalizador indicando que as notificações por e-mail devem ser enviadas. O Ops Manager retorna esse valor se você definir |
notificações.[n] | número | Número de minutos para aguardar entre notificações sucessivas para alertas não confirmados que não foram resolvidos. |
| string | URL do webhook de entrada do canal do Microsoft Teams. O Ops Manager retorna esse valor se você definir 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]. | 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 |
notificações.[n].notificationToken | string | Token de API do HipChat. O Ops Manager retorna esse valor se você definir Se o token se tornar inválido posteriormente, o MongoDB Atlas enviará um e-mail para 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ê:
|
notificações.[n].opsGenieApiKey | string | Chave API de alerta OpsGenie. O Ops Manager retorna esse valor se você definir Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
notificações.[n].opsGenieRegion | string | Região que indica qual URL da API usar. O Ops Manager retorna esse valor se você definir |
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 |
notificações.[n] | string | Nome da divisão do HipChat. O Ops Manager retorna esse valor se |
notificações.[n] | string | Chave de serviço PagerDuty. O Ops Manager retorna esse valor se você definir Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
| booleano | O sinalizador indicando que as notificações de texto devem ser enviadas. O Ops Manager retorna esse valor se você definir |
notificações.[n] | string | Identificador único da equipe que recebe esta notificação. |
| string | Etiqueta para a equipe que recebe esta notificação. |
notificações.[n] | 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 |
| string | Chave de API VictorOps. Se a chave se tornar inválida posteriormente, o MongoDB Atlas enviará um e-mail para o O Ops Manager retorna esse valor se você definir Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
| string | Chave de roteamento VictorOps. Se a chave se tornar inválida posteriormente, o MongoDB Atlas enviará um e-mail para o O Ops Manager retorna esse valor se você definir |
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
Depois de criar uma notificação de webhook, o URL é parcialmente redigido quando você visualiza ou edita o alerta, e o segredo é totalmente redigido. |
notificações.[n] | string | URL do webhook que Atlas Triggers essa notificação. O Ops Manager retorna esse valor se você definir
Depois de criar uma notificação de webhook, o URL é parcialmente redigido quando você visualiza ou edita o alerta, e o segredo é totalmente redigido. |
| string | Modelo de cabeçalhos personalizados para incluir em notificações de webhook. O Ops Manager retorna esse valor se você definir |
| string | Modelo para o conteúdo do corpo das notificações de webhook. O Ops Manager retorna esse valor se você definir |
notificações.[n].id | string | Identificador único da configuração de notificação. |
limite | objeto | Limite que Atlas Triggers um alerta. O Ops Manager retorna esse valor se |
limite | 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 | número | Valor que, quando excedido, o Ops Manager aciona um alerta. |
limiar | string | Unidades de capacidade ou tempo que definem o escopo do |
typeName | string | Este campo é preterido e é ignorado. |
Atualizado | string | Registro de data/hora no formato de data e hora ISO 8601 em UTC quando essa 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 PUT "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}" \ --data ' { "eventTypeName" : "RESYNC_REQUIRED", "enabled" : true, "matchers" : [ { "fieldName" : "REPLICA_SET_NAME", "operator" : "EQUALS", "value" : "rs1" } ], "notifications" : [ { "typeName" : "EMAIL", "emailAddress" : "sos@example.com", "intervalMin" : 60, "delayMin" : 5 }, { "typeName" : "GROUP", "intervalMin" : 120, "delayMin" : 60, "smsEnabled" : true, "emailEnabled" : false }, { "typeName" : "WEBHOOK", "intervalMin" : 60, "delayMin" : 5, "webhookUrl" : "https://example.com/webhook", "webhookSecret" : "secret123", "webhookHeadersTemplate" : "{\"X-Alert-Type\": \"{{eventTypeName}}\"}", "webhookBodyTemplate" : "{\"alert\": \"{{eventTypeName}}\", \"project\": \"{{groupName}}\"}" } ] }'
Exemplo de resposta
Cabeçalho de resposta
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
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:52:29Z", "enabled" : false, "groupId" : "{PROJECT-ID}", "id" : "{ALERT-CONFIG-ID}", "links" : [], "matchers" : [ { "fieldName" : "REPLICA_SET_NAME", "operator" : "EQUALS", "value" : "rs1" } ], "notifications" : [ { "id" : "{NOTIFICATION-ID-1}", "delayMin" : 5, "emailAddress" : "sos@example.com", "intervalMin" : 60, "typeName" : "EMAIL" }, { "id" : "{NOTIFICATION-ID-2}", "delayMin" : 60, "emailEnabled" : false, "intervalMin" : 120, "smsEnabled" : true, "typeName" : "GROUP" }, { "id" : "{NOTIFICATION-ID-3}", "delayMin" : 5, "intervalMin" : 60, "typeName" : "WEBHOOK", "webhookUrl" : "https://example.com/webhook", "webhookSecret" : "***", "webhookHeadersTemplate" : "{\"X-Alert-Type\": \"{{eventTypeName}}\"}", "webhookBodyTemplate" : "{\"alert\": \"{{eventTypeName}}\", \"project\": \"{{groupName}}\"}" } ], "updated" : "2014-04-23T14:56:25Z" }