Receba um alerta global
Nesta página
Recupere um alerta identificado com seu ALERT-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
GET /globalAlerts/{ALERT-ID}
Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
|---|---|---|
ALERT-ID | string | Identificador único do alerta que você deseja recuperar. |
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
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
Nome | Tipo | Descrição | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
acknowledgedUntil | string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC pelo qual o alerta foi confirmado. MongoDB Ops Manager apresenta este campo se um usuário reconhecer este alerta. | ||||||||
acknowledgementComment | string | Comentário que o usuário que reconheceu este alerta esquerda. O Ops Manager apresenta este campo se um usuário reconheceu este alerta. | ||||||||
acknowledgingUsername | string | Nome de usuário do Ops Manager do usuário que reconheceu o alerta. O Ops Manager apresenta este campo se um usuário reconheceu este alerta. | ||||||||
alertConfigId | string | Identificador exclusivo da configuração de alerta global que acionou este alerta. | ||||||||
clusterId | string | Identificador único do cluster ao qual este alerta se aplica. O Ops Manager retorna esse campo para alertas globais nas categorias de: | ||||||||
clusterName | string | Dê um nome ao cluster ao qual esse alerta se aplica. O Ops Manager retorna esse campo para alertas globais nas categorias de: | ||||||||
created | string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o alerta foi criado. | ||||||||
currentValue | objeto | Valor atual da métrica que acionou o alerta. O Ops Manager retorna esse campo para alertas globais na categoria de host. | ||||||||
currentValue.number | número | Valor atual da métrica. | ||||||||
currentValue.units | string | Unidades para Os valores aceitos são:
Por exemplo, uma métrica que mede o consumo de memória pode usar | ||||||||
eventTypeName | string | Nome do evento que acionou o 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. | ||||||||
groupId | string | Identificador único do projeto para o qual este alerta foi aberto. | ||||||||
hostId | string | Identificador único do host ao qual a métrica pertence. O Ops Manager retorna esse campo para alertas globais nas categorias de: | ||||||||
hostnameAndPort | string | Nome do host e porta de cada host ao qual o alerta se aplica. O nome do host pode ser apenas um nome de host, um FQDN, um endereço IPv4 ou um endereço IPv6 . O Ops Manager retorna esse campo para alertas globais nas categorias de: | ||||||||
id | string | Identificador único do alerta. | ||||||||
lastNotified | string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando a última notificação foi enviada para este alerta. MongoDB Ops Manager exibe isso se o MongoDB Ops Manager enviou notificações. | ||||||||
metricName | string | Nome da medição cujo valor ficou fora do limite. Ops Manager retorna este campo se Para obter valores possíveis, consulte Tipos de medição para Alertas Globais. | ||||||||
replicaSetName | string | Nome do conjunto de réplicas. O Ops Manager retorna esse campo para alertas globais nas categorias de: | ||||||||
resolved | string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o alerta foi fechado. MongoDB Ops Manager retorna esse campo para alertas globais quando "status" : "CLOSED". | ||||||||
sourceTypeName | string | Tipo de host que está sendo copiado. O Ops Manager retorna esse campo para alertas globais na categoria de backup. Os possíveis valores que podem ser retornados incluem:
| ||||||||
status | string | Estado atual do alerta. Os possíveis valores que podem ser retornados incluem:
| ||||||||
tags | array de strings | Marcações associadas a este 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 este alerta foi atualizado pela última vez. |
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlerts/{ALERT-ID}"
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 "alertConfigId": "{ALERT-CONFIG-ID}", 3 "created": "2019-11-30T12:42:31Z", 4 "eventTypeName": "BACKUP_AGENT_DOWN", 5 "groupId": "{PROJECT-ID}", 6 "id": "{ALERT-ID}", 7 "lastNotified": "2020-04-09T20:25:05Z", 8 "links": [ 9 ], 10 "status": "OPEN", 11 "tags": [], 12 "typeName": "AGENT", 13 "updated": "2019-11-30T12:42:31Z" 14 }