Obter um alerta

Nesta página

Resource

Parâmetros do caminho da solicitação
Solicitar parâmetros de query
Parâmetros do corpo da solicitação
Resposta
Tipos de medição para alertas
Exemplo de solicitação
Exemplo de resposta
Cabeçalho de resposta
Corpo de resposta

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/{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:

Nome	Descrição
`status`	Código de resposta HTTP
`content`	Corpo de resposta esperado

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
`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 `"eventTypeName" : "SHARDED_CLUSTER"`
`clusterName`	string	Nome do cluster ao qual este alerta se aplica. O Ops Manager retorna esse valor se `"eventTypeName" : "SHARDED_CLUSTER"`
`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 `"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"`.
`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: `RAW` `BITS` `BYTES` `KILOBITS` `KILOBYTES` `MEGABITS` `MEGABYTES` `GIGABITS` `GIGABYTES` `TERABYTES` `PETABYTES` `MILLISECONDS` `SECONDS` `MINUTES` `HOURS` `DAYS`
`eventTypeName`	string	Nome do evento que acionou o alerta. Os valores aceitos são: Agente `AUTOMATION_AGENT_DOWN` `AUTOMATION_AGENT_UP` `BACKUP_AGENT_CONF_CALL_FAILURE` `BACKUP_AGENT_DOWN` `BACKUP_AGENT_UP` `BACKUP_AGENT_VERSION_BEHIND` `BACKUP_AGENT_VERSION_CURRENT` `MONITORING_AGENT_DOWN` `MONITORING_AGENT_UP` `MONITORING_AGENT_VERSION_BEHIND` `MONITORING_AGENT_VERSION_CURRENT` `NEW_AGENT` Configuração da automação `AUTOMATION_CONFIG_PUBLISHED_AUDIT` Backup - `BAD_CLUSTERSHOTS` - `CLUSTER_BLACKLIST_UPDATED_AUDIT` - `CLUSTER_CHECKKPOINT_UPDATED_AUDIT` - `CLUSTER_CREDENTIAL_UPDATED_AUDIT` - `CLUSTER_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` - `CLUSTER_STATE_CHANGED_AUDIT` - `CLUSTER_STORAGE_ENGINE_UPDATED_AUDIT` - `CLUSTERSHOT_DELETED_AUDIT` - `CLUSTERSHOT_EXPIRY_UPDATED_AUDIT` - `CONSISTENT_BACKUP_CONFIGURATION` - `GOOD_CLUSTERSHOT` - `INCONSISTENT_BACKUP_CONFIGURATION` - `INITIAL_SYNC_FINISHED_AUDIT` - `INITIAL_SYNC_STARTED_AUDIT` - `OPLOG_BEHIND` - `OPLOG_CURRENT` - `RESTORE_REQUESTED_AUDIT` - `RESYNC_PERFORMED` - `RESYNC_REQUIRED` - `RS_BLACKLIST_UPDATED_AUDIT` - `RS_CREDENTIAL_UPDATED_AUDIT` - `RS_ROTATE_MASTER_KEY_AUDIT` - `RS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` - `RS_STATE_CHANGED_AUDIT` - `RS_STORAGE_ENGINE_UPDATED_AUDIT` - `SNAPSHOT_DELETED_AUDIT` - `SNAPSHOT_EXPIRY_UPDATED_AUDIT` - `SYNC_PENDING_AUDIT` - `SYNC_REQUIRED_AUDIT` BI Connector `BI_CONNECTOR_DOWN` `BI_CONNECTOR_UP` cluster `CLUSTER_MONGOS_IS_MISSING` `CLUSTER_MONGOS_IS_PRESENT` `SHARD_ADDED` `SHARD_REMOVED` Data Explorer acessado `DATA_EXPLORER` `DATA_EXPLORER_CRUD` Anfitrião `ATTEMPT_KILLOP_AUDIT` `ATTEMPT_KILLSESSION_AUDIT` `DB_PROFILER_DISABLE_AUDIT` `DB_PROFILER_ENABLE_AUDIT` `DISABLE_HOST_AUDIT` `HIDE_AND_DISABLE_HOST_AUDIT` `HIDE_HOST_AUDIT` `HOST_DOWN` `HOST_DOWNGRADED` `HOST_IP_CHANGED_AUDIT` `HOST_NOW_PRIMARY` `HOST_NOW_SECONDARY` `HOST_NOW_STANDALONE` `HOST_RECOVERED` `HOST_RECOVERING` `HOST_SECURITY_CHECKUP_NOT_MET` `HOST_SSL_CERTIFICATE_CURRENT` `HOST_SSL_CERTIFICATE_STALE` `HOST_UP` `HOST_UPGRADED` `INSIDE_METRIC_THRESHOLD` `NEW_HOST` `OUTSIDE_METRIC_THRESHOLD` `PAUSE_HOST_AUDIT` `RESUME_HOST_AUDIT` `UNDELETE_HOST_AUDIT` `VERSION_BEHIND` `VERSION_CHANGED` `VERSION_CURRENT` Organização `ALL_ORG_USERS_HAVE_MFA` `ORG_API_KEY_ADDED` `ORG_API_KEY_DELETED` `ORG_EMPLOYEE_ACCESS_RESTRICTED` `ORG_EMPLOYEE_ACCESS_UNRESTRICTED` `ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED` `ORG_PUBLIC_API_ACCESS_LIST_REQUIRED` `ORG_RENAMED` `ORG_TWO_FACTOR_AUTH_OPTIONAL` `ORG_TWO_FACTOR_AUTH_REQUIRED` `ORG_USERS_WITHOUT_MFA` Projeto `ALL_USERS_HAVE_MULTI_FACTOR_AUTH` `USERS_WITHOUT_MULTI_FACTOR_AUTH` Conjunto de réplicas `CONFIGURATION_CHANGED` `ENOUGH_HEALTHY_MEMBERS` `MEMBER_ADDED` `MEMBER_REMOVED` `MULTIPLE_PRIMARIES` `NO_PRIMARY` `ONE_PRIMARY` `TOO_FEW_HEALTHY_MEMBERS` `TOO_MANY_ELECTIONS` `TOO_MANY_UNHEALTHY_MEMBERS` team `TEAM_ADDED_TO_GROUP` `TEAM_CREATED` `TEAM_DELETED` `TEAM_NAME_CHANGED` `TEAM_REMOVED_FROM_GROUP` `TEAM_ROLES_MODIFIED` `TEAM_UPDATED` `USER_ADDED_TO_TEAM` Usuário `INVITED_TO_GROUP` `INVITED_TO_ORG` `JOIN_GROUP_REQUEST_APPROVED_AUDIT` `JOIN_GROUP_REQUEST_DENIED_AUDIT` `JOINED_TEAM` `REMOVED_FROM_TEAM` `REQUESTED_TO_JOIN_GROUP` 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 `"eventTypeName"` foi definido para um dos seguintes: `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`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 `"eventTypeName"` foi definido para um dos seguintes: `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`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 `links` nas respostas incluem pelo menos um link chamado `self`. Os relacionamentos entre URLs são explicados na Especificação de links da web.
`metricName`	string	Nome da medição cujo valor ficou fora do limite. O Ops Manager retorna esse valor se `"eventTypeName"` tiver sido definido como `OUTSIDE_METRIC_THRESHOLD`. Para obter 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 `"eventTypeName"` foi definido para um dos seguintes: `BACKUP` `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`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" : "CLOSED"`.
`status`	string	Estado atual do alerta. O Ops Manager pode retornar um dos seguintes: `TRACKING` A condição de alerta existe, mas não persistiu além do atraso de notificação definido. Para obter detalhes, consulte Solicitar parâmetros de query. `OPEN` `CLOSED` `CANCELLED`
`sourceTypeName`	string	Tipo de host que está sendo copiado quando `"eventTypeName" : "BACKUP"`. O Ops Manager pode retornar um dos seguintes: `REPLICA_SET` `SHARDED_CLUSTER` `CONFIG_SERVER`
`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

`ASSERT_REGULAR` `ASSERT_WARNING` `ASSERT_MSG` `ASSERT_USER`	Taxa de afirmações de um processo MongoDB encontrado no documento `asserts` que o comando serverStatus gera.
`BACKGROUND_FLUSH_AVG`	Quantidade de dados liberados em segundo plano.
`CACHE_BYTES_READ_INTO` `CACHE_BYTES_WRITTEN_FROM` `CACHE_DIRTY_BYTES` `CACHE_USED_BYTES` `TICKETS_AVAILABLE_READS` `TICKETS_AVAILABLE_WRITE`	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.
`CONNECTIONS`	Número de conexões a um processo MongoDB encontradas no documento `connections` que o comando serverStatus gera.
`CURSORS_TOTAL_OPEN` `CURSORS_TOTAL_TIMED_OUT`	Número de cursores para um processo MongoDB encontrado no documento `metrics.cursor` que o comando serverStatus gera.
`EXTRA_INFO_PAGE_FAULTS` `GLOBAL_ACCESSES_NOT_IN_MEMORY` `GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN`	Números de `Memory Issues` e `Page Faults` para um processo MongoDB.
`GLOBAL_LOCK_CURRENT_QUEUE_TOTAL` `GLOBAL_LOCK_CURRENT_QUEUE_READERS` `GLOBAL_LOCK_CURRENT_QUEUE_WRITERS`	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.
`INDEX_COUNTERS_BTREE_ACCESSES` `INDEX_COUNTERS_BTREE_HITS` `INDEX_COUNTERS_BTREE_MISSES` `INDEX_COUNTERS_BTREE_MISS_RATIO`	Número de operações do índice b.
`JOURNALING_COMMITS_IN_WRITE_LOCK` `JOURNALING_MB` `JOURNALING_WRITE_DATA_FILES_MB`	Número de operações de registro no diário.
`MEMORY_RESIDENT` `MEMORY_VIRTUAL` `MEMORY_MAPPED` `COMPUTED_MEMORY`	Quantidade de memória para um processo MongoDB localizado no documento `mem` que o comando serverStatus coleta.
`NETWORK_BYTES_IN` `NETWORK_BYTES_OUT` `NETWORK_NUM_REQUESTS`	Quantidade de rendimento para o processo MongoDB encontrada no documento `network` que o comando serverStatus coleta.
`OPLOG_RATE_GB_PER_HOUR` `OPLOG_MASTER_TIME` `OPLOG_MASTER_LAG_TIME_DIFF` `OPLOG_SLAVE_LAG_MASTER_TIME`	Durações e taxa de transferência do oplog do processo MongoDB.
`DB_STORAGE_TOTAL` `DB_DATA_SIZE_TOTAL`	Espaço de armazenamento no disco conforme coletado do comando MongoDB `dbStats` .
`OPCOUNTER_CMD` `OPCOUNTER_QUERY` `OPCOUNTER_UPDATE` `OPCOUNTER_DELETE` `OPCOUNTER_GETMORE` `OPCOUNTER_INSERT`	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.
`OPCOUNTER_REPL_CMD` `OPCOUNTER_REPL_UPDATE` `OPCOUNTER_REPL_DELETE` `OPCOUNTER_REPL_INSERT`	Taxa de operações de banco de dados em secundários MongoDB encontrados no documento `opcountersRepl` que o comando serverStatus coleta.
`DOCUMENT_METRICS_RETURNED` `DOCUMENT_METRICS_INSERTED` `DOCUMENT_METRICS_UPDATED` `DOCUMENT_METRICS_DELETED`	Taxa média de documentos devolvidos, inseridos, atualizados ou excluídos por segundo durante um período selecionado.
`OPERATIONS_SCAN_AND_ORDER`	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.
`OP_EXECUTION_TIME_READS` `OP_EXECUTION_TIME_WRITES` `OP_EXECUTION_TIME_COMMANDS`	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.
`RESTARTS_IN_LAST_HOUR`	Número de vezes que o host reiniciou na hora anterior.
`SYSTEM_MEMORY_USED` `SYSTEM_MEMORY_FREE` `SYSTEM_MEMORY_AVAILABLE`	Uso de memória física, em bytes.
`SYSTEM_NETWORK_BYTES_IN` `SYSTEM_NETWORK_BYTES_OUT`	Taxa de transferência da rede em bytes por segundo.
`SWAP_USAGE_USED` `SWAP_USAGE_FREE`	Quantidade total de espaço de troca em uso.

`QUERY_EXECUTOR_SCANNED`	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 .
`QUERY_EXECUTOR_SCANNED_OBJECTS`	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 .
`QUERY_TARGETING_SCANNED_PER_RETURNED`	Proporção do número de itens de índice digitalizados para o número de documentos devolvidos.
`QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED`	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://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-ID}"

Exemplo de resposta

Cabeçalho de resposta

HTTP/1.1 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

HTTP/1.1 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" : [ ... ]
}

Voltar

Obter todos os alertas

Reconhecer um alerta