Obter todos os alertas
Nesta página
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
GET /groups/{PROJECT-ID}/alerts
Parâmetros do caminho da solicitação
Parâmetro | Tipo | Descrição |
---|---|---|
ID do projeto | string | (Obrigatório.) Identificador do projeto. |
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 |
Nome | Tipo | necessidade | Descrição |
---|---|---|---|
status | string | Opcional | Especifique um status para retornar apenas os alertas com o status especificado. Omitir para retornar todos os alertas. O Ops Manager aceita os seguintes valores:
|
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 é um alerta.
Nome | Tipo | Descrição |
---|---|---|
acknowledged Until | string | Carimbo de data/hora na ISO 8601 formato de data e hora no UTC até o qual o alerta foi confirmado. O Ops Manager retorna esse valor se o alerta tiver sido confirmado. |
acknowledgement Comment | string | Comentário deixado pelo usuário que reconheceu o alerta. O Ops Manager retorna esse valor se o alerta tiver sido confirmado. |
acknowledging Username | string | Nome de usuário do usuário que reconheceu o alerta. O Ops Manager retorna esse valor se o alerta tiver sido confirmado. |
alertConfigId | string | Identificador exclusivo para a configuração de alerta que acionou este alerta. |
clusterId | string | Identificador único do cluster ao qual este alerta se aplica. O Ops Manager retorna esse valor se
|
clusterName | string | Nome do cluster ao qual este alerta se aplica. O Ops Manager retorna esse valor se
|
created | string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o alerta foi aberto. |
currentValue | objeto | Valor atual da métrica que acionou o alerta. O Ops Manager retorna esse valor se |
currentValue .number | número | Valor da métrica. |
currentValue .units | string | Unidades para o valor. O valor 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. O Ops Manager pode retornar:
|
eventTypeName | string | Nome do evento que acionou o alerta. Os valores aceitos são: 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 obter uma lista completa de eventos incluídos no registro de auditoria do Ops Manager, consulte Eventos de auditoria. |
groupId | string | Identificador único do grupo para o qual este alerta foi aberto. |
hostId | string | identificador exclusivo do host ao qual a métrica pertence. O Ops Manager retorna este valor se
|
hostnameAndPort | string | Nome do host e porta de cada host ao qual o alerta se aplica. Pode ser um nome de host, um FQDN, um endereço IPv4 ou um endereço IPv6 . O Ops Manager retorna este valor se
|
id | string | Identificador único para o 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 retorna esse valor se notificações tiverem sido enviadas. |
links | Array de objetos | Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays |
metricName | string | Nome da medição cujo valor ficou fora do limite. O Ops Manager retorna esse valor se Para obter os valores possíveis, consulte Tipos de medição para alertas. |
replicaSetName | string | Nome do conjunto de réplicas. O Ops Manager retorna este valor se
|
resolved | string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o alerta foi fechado. O Ops Manager retorna esse valor se |
status | string | Estado atual do alerta. O Ops Manager pode retornar um dos seguintes:
|
sourceTypeName | string | Tipo de host que está sendo copiado quando
|
tags | array de strings | Identificar rótulos definidos para este alerta. |
updated | string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o alerta foi atualizado pela última vez. |
Tipos de medição para alertas
O recurso alerts
retorna tipos de medição no campo metricName
. O campo está presente somente se eventTypeName
estiver definido como OUTSIDE_METRIC_THRESHOLD
.
Medições do host
| Taxa de afirmações de um processo MongoDB encontrado no documento asserts que o comando serverStatus gera. |
| Quantidade de dados liberados em segundo plano. |
| Quantidade de bytes no WiredTiger storage engine cache do wiredTiger.cache e tickets encontrados nos documentos do e wiredTiger.concurrentTransactions que o comando serverStatus gera. |
| Número de conexões a um processo MongoDB encontradas no documento connections que o comando serverStatus gera. |
| Número de cursores para um processo MongoDB encontrado no documento metrics.cursor que o comando serverStatus gera. |
| Números de Memory Issues e Page Faults para um processo MongoDB. |
| Número de operações aguardando travas para o processo MongoDB que o comando serverStatus gera. MongoDB Ops Manager calcula esses valores com base no tipo de mecanismo de armazenamento. |
| Número de operações do índice b. |
| Número de operações de registro no diário. |
| Quantidade de memória para um processo MongoDB localizado no documento mem que o comando serverStatus coleta. |
| Quantidade de rendimento para o processo MongoDB encontrada no documento network que o comando serverStatus coleta. |
| Durações e taxa de transferência do oplog do processo MongoDB. |
| Espaço de armazenamento no disco conforme coletado do comando MongoDB dbStats . |
| Taxa de operações de banco de dados em um processo MongoDB desde a última vez que o processo foi iniciado, encontrado no documento opcounters que o comando serverStatus coleta. |
| Taxa de operações de banco de dados em secundários MongoDB encontrados no documento opcountersRepl que o comando serverStatus coleta. |
| Taxa média de documentos devolvidos, inseridos, atualizados ou excluídos por segundo durante um período selecionado. |
| Taxa média de operações por segundo durante um período de tempo selecionado que executa uma classificação, mas não pode executá-la usando um índice. |
| Tempo médio de execução em milissegundos por operação de leitura, gravação ou comando durante um período de tempo selecionado. Disponível para hosts que executam o MongoDB 3.4 ou posterior. |
| Número de vezes que o host reiniciou na hora anterior. |
| Uso de memória física, em bytes. |
| Taxa de transferência da rede em bytes por segundo. |
| Quantidade total de espaço de troca em uso. |
| Taxa média por segundo para verificar itens de índice durante queries e avaliações do plano de query encontradas no valor de totalKeysExamined do comando explain . |
| Taxa média de documentos digitalizados por segundo durante queries e avaliações do plano de query encontradas no valor de totalDocsExamined do comando de explicação . |
| Proporção do número de itens de índice digitalizados para o número de documentos devolvidos. |
| Proporção do número de documentos digitalizados para o número de documentos devolvidos. |
Exemplo de solicitação
O seguinte retorna todos os alertas OPEN
:
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/alerts?status=OPEN&pretty=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
1 { 2 "links" : [ { 3 "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts?status=OPEN&pretty=true&pageNum=1&itemsPerPage=100", 4 "rel" : "self" 5 } ], 6 "results" : [ { 7 "alertConfigId" : "5953c5f380eef53887615fd4", 8 "created" : "2019-07-18T23:43:50Z", 9 "eventTypeName" : "MONITORING_AGENT_DOWN", 10 "groupId" : "{PROJECT-ID}", 11 "id" : "5d31043680eef5280d3664e0", 12 "lastNotified" : "2019-09-25T11:50:08Z", 13 "links" : [ { 14 "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts/5d31043680eef5280d3664e0", 15 "rel" : "self" 16 } ], 17 "status" : "OPEN", 18 "tags" : [ ], 19 "updated" : "2019-07-18T23:43:50Z" 20 } ], 21 "totalCount" : 1 22 }