/ /

Medições e alertas

Configurações de alerta

Página inicial do Docs

Configurações de alerta

Obter alertas abertos para configuração de alerta

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 termo grupo, que é mais familiar, ao se referir a descrições. O ponto de extremidade permanece conforme indicado no documento.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

GET /groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}/alerts

Parâmetros do caminho da solicitação

Todos os parâmetros do caminho da solicitação são obrigatórios.

Parâmetro	Tipo	Descrição
ID do projeto	string	Identificador único para este projeto.
alerta-CONFIG-ID	string	Identificador exclusivo para esta configuração de alerta.

Solicitar parâmetros de query

Os seguintes parâmetros de query são opcionais:

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 formato de impressão bonita.	`false`
envelope	booleano	Opcional	Sinalizador que indica se deseja ou não envolver a resposta em um envelope. Some API clients cannot access the HTTP response headers or status code. To remediate this, set `envelope : true` in the query. Para endpoints que retornam uma lista de resultados, o objeto `content` é um envelope. O Ops Manager adiciona o campo `status` ao corpo da resposta.	`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

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

Nome	Tipo	Descrição
`results`	array	A array inclui um objeto para cada item detalhado na seção `results` Documento incorporado.
`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.

Observação

Os detalhes do alerta variam. Um alerta pode incluir apenas um subconjunto desses elementos.

Nome	Tipo	Descrição
acknowledgedUntil	string	Registro de data/hora no formato de data e hora ISO 8601 em UTC quando o alerta foi confirmado. Preenchido se o alerta tiver sido reconhecido.
acknowledgedUsername	string	Nome de usuário do usuário que reconheceu o alerta. Preenchido se o alerta tiver sido reconhecido.
acknowledgementComment	string	Usuário de comentário que reconheceu o alerta deixado. Preenchido se o alerta tiver sido reconhecido.
alertConfigId	string	Identificador exclusivo da configuração de alerta que acionou esse alerta.
clusterId	string	Identificador único do cluster ao qual este alerta se aplica. Preenchido para alertas `BACKUP`, `REPLICA_SET` e `CLUSTER` .
clusterName	string	Dê um nome ao cluster ao qual esse alerta se aplica. Preenchido para alertas `BACKUP`, `REPLICA_SET` e `CLUSTER` .
Criado	string	Registro de data/hora no formato de data e hora ISO 8601 em UTC quando o alerta foi aberto.
currentValue	objeto	Valor atual da métrica que acionou o alerta. Preenchido para alertas de `HOST_METRIC` .
currentValue.number	número	Valor da métrica.
currentValue.units	string	Unidades para 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. Os valores aceitos são: `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 incluem: 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` Alertas `WEBHOOK_TEMPLATE_RENDER_FAILED` Configuração da automação `AUTOMATION_CONFIG_PUBLISHED_AUDIT` Backup. `BAD_CLUSTERSHOTS` `CLUSTER_DENYLIST_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_DENYLIST_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 `ADD_HOST_AUDIT` `ADD_HOST_TO_REPLICA_SET_AUDIT` `DELETE_HOST_AUDIT` `HOST_DOWN` `HOST_RECOVERING` `HOST_RESTARTED` `HOST_ROLLBACK` `HOST_SSL_CERTIFICATE_STALE` `OUTSIDE_METRIC_THRESHOLD` `REMOVE_HOST_FROM_REPLICA_SET_AUDIT` `UNDELETE_HOST_AUDIT` `VERSION_BEHIND` 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` `PRIMARY_ELECTED` `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_GROUP` `JOINED_ORG` `JOINED_TEAM` `REMOVED_FROM_GROUP` `REMOVED_FROM_ORG` `REMOVED_FROM_TEAM` `REQUESTED_TO_JOIN_GROUP` `USER_ROLES_CHANGED_AUDIT` Para ver a lista completa de eventos que geram alertas e suas descrições, 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. Preenchido para alertas `HOST`, `HOST_METRIC` e `REPLICA_SET` .
Nome de host e porta	string	Nome do host e porta de cada host ao qual o alerta se aplica. Preenchido para alertas `HOST`, `HOST_METRIC` e `REPLICA_SET` .
id	string	Identificador único para o alerta.
lastNotified	string	Registro de data/hora no formato de data e hora ISO 8601 em UTC quando a última notificação foi enviada para este alerta. Preenchido se as notificações tiverem sido enviadas.
metricName	string	Nome da medição cujo valor ficou fora do limite. Preenchido se `"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"`. Para obter os valores aceitos, consulte Tipos de medição para alertas nesta página.
ReplicaSetName	string	Nome do conjunto de réplicas. Preenchido para alertas `HOST`, `HOST_METRIC`, `BACKUP` e `REPLICA_SET` .
resolvido	string	Registro de data/hora no formato de data e hora ISO 8601 em UTC quando o alerta foi fechado. Preenchido se `"status" : "CLOSED"`.
sourceTypeName	string	Para alertas do `BACKUP` , o tipo de servidor que está sendo copiado. Os valores aceitos são: `REPLICA_SET` `SHARDED_CLUSTER` `CONFIG_SERVER`
Status	string	Estado atual do alerta. Os valores aceitos são: `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`
typeName	string	Este campo é preterido e será ignorado.
Atualizado	string	Registro de data/hora no formato de data e hora ISO 8601 em UTC quando o 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://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}/alerts"

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

{
  "links" : [],
  "results" : [ {
    "acknowledgedUntil" : "2014-05-01T14:00:00Z",
    "alertConfigId":"{ALERT-CONFIG-ID}",
    "created" : "2014-04-22T15:57:13.562Z",
    "currentValue" : {
      "number" : 0.0,
      "units" : "RAW"
    },
    "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
    "groupId" : "{PROJECT-ID}",
    "id" : "53569159300495c7702ee3a3",
    "lastNotified" : "2014-04-22T15:57:24.126Z",
    "links" : [],
    "metricName" : "ASSERT_REGULAR",
    "status" : "OPEN",
    "updated" : "2014-04-22T20:14:11.388Z"
  }, {
    "alertConfigId":"{ALERT-CONFIG-ID}",
    "created" : "2014-04-22T19:59:10.657Z",
    "currentValue" : {
      "number" : 0.0,
      "units" : "RAW"
    },
    "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
    "groupId" : "{PROJECT-ID}",
    "id" : "5356ca0e300495c770333340",
    "lastNotified" : "2014-04-22T20:14:19.313Z",
    "links" : [],
    "metricName" : "ASSERT_REGULAR",
    "status" : "OPEN",
    "updated" : "2014-04-22T20:14:11.388Z"
  } ],
  "totalCount" : 2
}

Voltar

Excluir

Teste a configuração de alerta de projeto