Página inicial do Docs → MongoDB Ops Manager
Habilitar ou desabilitar uma configuração de alerta global
Nesta página
Habilite ou desabilite uma configuração de alerta global identificada por seu GLOBAL-ALERT-CONFIG-ID
.
Funções obrigatórias
Você pode chamar esse endpoint com sucesso com qualquer um dos seguintes roles atribuídos:
Solicitar
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PUT /globalAlertConfigs/{GLOBAL-ALERT-CONFIG-ID}
Parâmetros do caminho da solicitação
Nome | Tipo | necessidade | Descrição |
---|---|---|---|
{GLOBAL-ALERT-CONFIG-ID} | string | Obrigatório | Identificador exclusivo da configuração de alerta global que você deseja habilitar ou desabilitar. |
Solicitar parâmetros de query
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:
| false |
Parâmetros do corpo da solicitação
Parâmetro do corpo | Tipo | necessidade | Descrição |
---|---|---|---|
enabled | booleano | Obrigatório | Alterne indicando se a configuração de alerta global está habilitada ou desabilitada:
|
Resposta
Nome | Tipo | Descrição |
---|---|---|
created | string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando a configuração de alerta foi criada. |
enabled | booleano | Alternar que especifica se a configuração de alerta está habilitada. |
eventTypeName | string | Tipo de evento para o qual essa configuração de alerta Atlas Triggers um alerta. Para revisar os tipos de eventos que geram alertas, consulte Tipos de Alerta. Para obter uma lista completa de eventos incluídos no registro de auditoria do Ops Manager, consulte Eventos de auditoria. |
forAllGroups | booleano | Alternar que especifica se a configuração de alerta global se aplica a todos os grupos. Também afeta se você pode usar a matriz Se Se |
groupIds | array de strings | ID dos grupos aos quais essa configuração de alerta se aplica. Este campo se aplica somente se forAllGroups estiver definido como false . |
id | string | Identificador único da configuração do alerta. |
matchers | Array de objetos | Regras a serem aplicadas ao corresponder um objeto a essa configuração de alerta global. O Ops Manager verifica apenas as entidades que correspondem a todas essas regras para uma condição de alerta. Você pode filtrar usando a array |
matchers.fieldName | string | Nome do campo no objeto de destino no qual corresponder.
Todos os outros tipos de alertas não suportam correspondedores. |
matchers.operator | string | Operador para testar o valor do campo. Os valores possíveis são:
|
matchers.value | string | Valor para testar com o operador especificado. Se
|
metricThreshold | objeto | Limite que faz com que essa configuração de alerta trigger um alerta. Somente presente se eventTypeName estiver definido como OUTSIDE_METRIC_THRESHOLD . |
metricThreshold.metricName | string | Nome da métrica a ser verificada. Suporta os mesmos valores que o campo metricName do recurso globalAlerts . Para obter uma lista de valores possíveis, consulte Tipos de medição para alerta Globais. |
metricThreshold.mode | string | É definido como AVERAGE e calcula o valor da métrica atual como uma média. |
metricThreshold.operator | string | Operador a ser aplicado ao verificar o valor da métrica atual em relação a
|
metricThreshold.threshold | número | O valor limite fora do qual essa configuração de alerta Atlas Triggers um alerta. |
metricThreshold.units | string | Unidades para ExemploUma métrica que mede o consumo de memória tem uma medida de bytes, enquanto uma métrica que mede o tempo tem uma unidade de tempo. Os valores possíveis são:
|
notifications | Array de objetos | Notificações que o Ops Manager envia quando detecta um alerta descrito por essa configuração de alerta. |
notifications.apiToken | string | Token de API do Slack ou token de Bot. Presente apenas para notificações ObservaçãoDepois 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. Presente apenas para notificações SLACK . |
notifications.delayMin | número | Número de minutos para aguardar após uma condição de alerta ser detectada antes que o Ops Manager envie a primeira notificação. |
notifications.emailAddress | string | Endereço de e-mail para o qual enviar a notificação. Presente apenas para notificações EMAIL . |
notifications.emailEnabled | booleano | Alterne a especificação se o Ops Manager envia notificações por e-mail. Presente apenas para notificações GROUP e USER . |
notifications.intervalMin | número | Número de minutos para aguardar entre notificações sucessivas para alerta não reconhecidos e não resolvidos que esta configuração de Atlas Triggers. |
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
ObservaçãoDepois de criar uma notificação de webhook, o URL aparecerá parcialmente redigido quando você visualizar ou editar o alerta, e o segredo aparecerá completamente redigido. |
notificações.[n] .webhookUrl | string | URL do webhook que Atlas Triggers essa notificação. O Ops Manager retorna esse valor se você definir
ObservaçãoDepois de criar uma notificação de webhook, o URL aparecerá parcialmente redigido quando você visualizar ou editar o alerta, e o segredo aparecerá completamente redigido. |
notifications.microsoftTeamsWebhookUrl | string | URL do webhook de entrada do canal do Microsoft equipe. Presente apenas para notificações ObservaçãoQuando você exibe ou edita o alerta de uma notificação de webhook, o URL aparece parcialmente redigido, e o segredo aparece completamente redigido. |
notifications.notificationToken | string | Token de API do HipChat. Presente apenas para notificações ObservaçãoDepois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
notifications.roomName | string | Nome da divisão do HipChat. Presente apenas para notificações HIP_CHAT . |
notifications.serviceKey | string | Chave de integração PagerDuty. Presente apenas para notificações ObservaçãoDepois 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 | Alterne a especificação se o Ops Manager envia notificações por SMS. Presente apenas para notificações GROUP e USER . |
notifications.typeName | string | Tipo de notificação de alerta que essa configuração de alerta Atlas Triggers. Os valores possíveis são:
|
notifications.username | string | Nome do usuário do Ops Manager para quem enviar notificações. Presente apenas para notificações USER . |
threshold | objeto | Limite que faz com que essa configuração de alerta trigger um alerta. Somente presente se
|
threshold.operator | string | Operador a ser aplicado ao verificar o valor da métrica atual em relação a
|
threshold.threshold | número | O valor limite fora do qual essa configuração de alerta Atlas Triggers um alerta. |
tags | array de strings | Marcações associadas a esta configuração de alerta. |
typeName | string | Este campo é preterido e será ignorado. |
updated | 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
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request PUT "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs/{GLOBAL-ALERT-CONFIG-ID}" \ 6 --data '{ 7 "enabled" : false 8 }'
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
1 { 2 "created": "2019-10-02T12:34:04Z", 3 "enabled": false, 4 "eventTypeName": "BACKUP_AGENT_DOWN", 5 "forAllGroups": true, 6 "groupIds": [], 7 "id": "{GLOBAL-ALERT-CONFIG-ID}", 8 "links": [ 9 ], 10 "matchers": [], 11 "notifications": [ 12 { 13 "delayMin": 0, 14 "intervalMin": 60, 15 "typeName": "ADMIN" 16 } 17 ], 18 "tags": [], 19 "typeName": "AGENT", 20 "updated": "2019-10-02T12:34:04Z" 21 }