Obter todas as configurações de alerta globais
Nesta página
Recupere todas as configurações de alerta globais.
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
GET /globalAlertConfigs
Parâmetros do caminho da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Solicitar parâmetros de query
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 Para endpoints que retornam uma lista de resultados, o objeto | false |
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
documento de resposta
O documento JSON de resposta inclui uma array de objetos result , uma array de objetos link e uma contagem do número total de objetos result recuperados.
Nome | Tipo | Descrição |
---|---|---|
results | array | A array inclui um objeto para cada item detalhado na seção Documento incorporado results . |
links | array | A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web. |
totalCount | número | Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado. |
results
documento incorporado
Cada resultado é uma configuração de alerta.
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 esta 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 array Se Se |
groupIds | array de strings | IDs 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 combinar um objeto com esta configuração de alerta global. MongoDB Ops Manager verifica apenas 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 ao 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 alertas globais. |
metricThreshold.mode | string | É definido como AVERAGE e calcula o valor da métrica atual como uma média. |
metricThreshold.operator | string | Operador para aplicar ao verificar o valor da métrica atual em relação a
|
metricThreshold.threshold | número | Valor limite fora do qual essa configuração de alerta Atlas Triggers um alerta. |
metricThreshold.units | string | Unidades para Os valores aceitos são:
Por exemplo, uma métrica que mede o consumo de memória pode usar |
notifications | Array de objetos | Notificações que o MongoDB Ops Manager envia quando detecta um alerta descrito por esta configuração de alerta. |
notifications.apiToken | string | Token de API do Slack ou token de Bot. Presente apenas para 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. Presente apenas para SLACK notificações. |
notifications.delayMin | número | Número de minutos de espera depois que uma condição de alerta é detectada antes que o MongoDB 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 EMAIL notificações. |
notifications.emailEnabled | booleano | Alterne especificando se MongoDB Ops Manager envia notificações por e-mail. Presente apenas para notificações GROUP e USER . |
notifications.intervalMin | número | Número de minutos de espera entre notificações sucessivas para alertas não reconhecidos e não resolvidos que esta configuração de alerta Atlas Triggers. |
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. |
notifications.microsoftTeamsWebhookUrl | string | URL do webhook de entrada do canal do Microsoft Teams. Presente apenas para 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.notificationToken | string | Token da API do HipChat. Presente apenas para 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.roomName | string | Nome da sala do HipChat. Presente apenas para HIP_CHAT notificações. |
notifications.serviceKey | string | Chave de integração PagerDuty. Presente apenas para 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 | Alterne a especificação se o MongoDB 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 esta configuração de alerta Atlas Triggers. Os valores possíveis são:
|
notifications.username | string | Nome do usuário do MongoDB Ops Manager para quem enviar notificações. Presente apenas para USER notificações. |
threshold | objeto | Limite que faz com que essa configuração de alerta trigger um alerta. Somente presente se
|
threshold.operator | string | Operador para aplicar ao verificar o valor da métrica atual em relação a
|
threshold.threshold | número | Valor limite fora do qual essa configuração de alerta Atlas Triggers um alerta. |
tags | array de strings | Tags 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 --include \ 4 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs"
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 "links": [ 3 ], 4 "results": [ 5 { 6 "created": "2019-10-02T12:34:04Z", 7 "enabled": true, 8 "eventTypeName": "RS_BIND_ERROR", 9 "forAllGroups": true, 10 "groupIds": [], 11 "id": "{GLOBAL-ALERT-CONFIG-ID}", 12 "links": [ 13 ], 14 "matchers": [], 15 "notifications": [ 16 { 17 "delayMin": 0, 18 "intervalMin": 60, 19 "typeName": "ADMIN" 20 } 21 ], 22 "tags": [], 23 "typeName": "BACKUP", 24 "updated": "2019-10-02T12:34:04Z" 25 }, 26 { 27 "created": "2019-10-02T12:34:04Z", 28 "enabled": true, 29 "eventTypeName": "BACKUP_TOO_MANY_RETRIES", 30 "forAllGroups": true, 31 "groupIds": [], 32 "id": "{GLOBAL-ALERT-CONFIG-ID}", 33 "links": [ 34 ], 35 "matchers": [], 36 "notifications": [ 37 { 38 "delayMin": 0, 39 "intervalMin": 60, 40 "typeName": "ADMIN" 41 } 42 ], 43 "tags": [], 44 "typeName": "BACKUP", 45 "updated": "2019-10-02T12:34:04Z" 46 }, 47 { 48 "created": "2019-10-02T12:34:04Z", 49 "enabled": true, 50 "eventTypeName": "BACKUP_IN_UNEXPECTED_STATE", 51 "forAllGroups": true, 52 "groupIds": [], 53 "id": "{GLOBAL-ALERT-CONFIG-ID}", 54 "links": [ 55 ], 56 "matchers": [], 57 "notifications": [ 58 { 59 "delayMin": 0, 60 "intervalMin": 60, 61 "typeName": "ADMIN" 62 } 63 ], 64 "tags": [], 65 "typeName": "BACKUP", 66 "updated": "2019-10-02T12:34:04Z" 67 } 68 ], 69 "totalCount": 3 70 }