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
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 | 
 | |||||||
| 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: 
 | 
 | 
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 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. | 
| correspondências.fieldName | string | Nome do campo no objeto de destino a ser correspondido. 
 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: 
 | 
| correspondente.value | string | Valor para testar com o operador especificado. Se  
 | 
| 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  | 
| metricThreshold.metricName | string | Nome da métrica a ser verificada. Suporta os mesmos valores que o campo  | 
| metricThreshold.mode | string | Defina como  | 
| 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: 
 | 
| 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. ExemploUma 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 | Limite que fará com que um alerta seja acionado. Necessário se  | 
| notifications.apiToken | string | 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ê: 
 | 
| notifications.channelName | string | Nome do canal do Slack. Necessário se  | 
| notifications.datadogApiKey | string | 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ê: 
 | 
| 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.emailEnabled | booleano | Determina se as notificações por e-mail devem ser enviadas. Necessário se: 
 | 
| 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: 
 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. | 
| notifications.webhookUrl | string | 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. | 
| notifications.microsoftTeamsWebhookUrl | string | 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. | 
| notifications. mobileNumber | string | Número de celular para enviar mensagens SMS. Necessário se  | 
| notifications.notificationToken | string | 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 | Função de Ops Manager no projeto atual. Necessário se  | 
| notifications.roomName | string | Nome da divisão do HipChat. Necessário se  | 
| notifications.serviceKey | string | 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ê: 
 | 
| notifications.smsEnabled | booleano | Sinalizador que indica que as notificações por SMS devem ser enviadas. Necessário se: 
 | 
| notifications.teamId | string | Identificador único de uma equipe. | 
| notifications.typeName | string | Tipo de notificação de alerta. Os valores aceitos são: 
 | 
| notifications.username | string | 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  | 
| 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. 
 | 
| 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: 
 | 
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. | 
| 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  | 
| matchers .[n].value | string | Valor para corresponder ou exceder usando  | 
| 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  | 
| 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 .units | 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. | 
| notifications.[n] .apiToken | 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ê: 
 | 
| notifications.[n] .channelName | string | Nome do canal do Slack. O Ops Manager retorna esse valor se você definir  | 
| notifications.[n] .datadogApiKey | 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ê: 
 | 
| 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] .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] .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  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] .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ê: 
 | 
| notifications.[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ê: 
 | 
| notifications.[n] .opsGenieRegion | string | Região que indica qual URL da API usar. O Ops Manager retorna esse valor se você definir  | 
| 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] .roomName | string | Nome da divisão do HipChat. O Ops Manager retorna esse valor se  | 
| notifications.[n] .serviceKey | 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ê: 
 | 
| 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] .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  ImportanteMongoDB 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] .victorOpsApiKey | 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ê: 
 | 
| 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  O Ops Manager retorna esse valor se você definir  | 
| 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  
 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  
 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  | 
| 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  | 
| 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 POST "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs" \  --data '    {      "eventTypeName" : "RESYNC_REQUIRED",      "enabled" : true,      "notifications" : [ {        "typeName" : "GROUP",        "intervalMin" : 5,        "delayMin" : 0,        "smsEnabled" : false,        "emailEnabled" : true      } ]    }' 
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: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" }