Obter um alerta
Nesta página
- A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.
- O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .
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://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/alerts/{ALERT-ID}
Parâmetros do caminho da solicitação
Parâmetro | Tipo | Descrição |
|---|---|---|
ID do projeto | string | (Obrigatório.) Identificador do projeto. |
ID DE AVISO | string | (Obrigatório.) Identificador de alerta. |
Solicitar parâmetros de query
Os seguintes parâmetros de query são opcionais:
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
Os campos no documento de devolução dependem do tipo de alerta:
Nome | Tipo | Descrição |
|---|---|---|
acknowledgedUntil | string | Carimbo de data/hora na ISO 8601 formato de data e hora no UTC até o qual o alerta foi confirmado. O Cloud Manager retorna esse valor se o alerta tiver sido confirmado. |
acknowledgementComment | string | Comentário deixado pelo usuário que reconheceu o alerta. O Cloud Manager retorna esse valor se o alerta tiver sido confirmado. |
acknowledgingUsername | string | Nome de usuário do usuário que reconheceu o alerta. O Cloud 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. Cloud Manager retorna esse valor se
|
clusterName | string | Nome do cluster ao qual este alerta se aplica. Cloud 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 Cloud 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 Cloud 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
Cobrança cluster
Data Explorer acessado
Backup em disco Anfitrião Organização Projeto Conjunto de réplicas Caso de suporte team
Usuário |
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. Cloud Manager retornará 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 . Cloud Manager retornará 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. O Cloud 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. Cloud Manager retornará esse valor se Para obter valores possíveis, consulte Tipos de medição para alertas. |
replicaSetName | string | Nome do conjunto de réplicas. Cloud Manager retornará 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 Cloud Manager retorna esse valor se |
status | string | Estado atual do alerta. O Cloud 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. |
typeName | string | Campo obsoleto. |mms| ignora. |
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. O Cloud Manager calcula esses valores com base no tipo de storage engine. |
| 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
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts/{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
{ "alertConfigId" : "5b43d04087d9d6357de591aa", "created" : "2019-07-26T21:12:19Z", "currentValue" : { "number" : 100, "units" : "RAW" }, "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD", "humanReadable" : "Project: testProj Organization: testOrg Alert acknowledged by user@example.com until 2019/10/17 19:48 GMT. Comment: N/A Connections has gone below 1000 mycluster.example.com:27017 Created: 2019/10/17 15:26 GMT Replica Set: cluster0-shard-0 Type: Primary Current Value: 100" "groupId" : "535683b3794d371327b", "hostnameAndPort" : "mycluster.example.com:27017", "id" : "533cb4b8e4b0f1820cdabc7f", "lastNotified" : "2019-07-26T21:13:48Z", "metricName" : "CONNECTIONS", "replicaSetName" : "mycluster", "resolved" : "2019-07-26T21:13:42Z", "status" : "CLOSED", "typeName" : "HOST_METRIC", "updated" : "2019-07-26T21:13:42Z", "links" : [ ... ] }