Obter um evento da organização
Nesta página
Funções obrigatórias
Sua chave de API deve ter a função Organization Member
para chamar esse recurso com êxito.
Solicitar
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /orgs/{orgId}/events/{eventId}
Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
---|---|---|
orgId | string | Identificador único da organização associada ao evento desejado. |
eventId | string | Identificador único do evento desejado. |
Solicitar parâmetros de query
Os seguintes parâmetros de query são opcionais:
Parâmetro de query | Tipo | Descrição | Default |
---|---|---|---|
pretty | booleano | Exibe a resposta em um prettyprint formato. | false |
envelope | booleano | Especifica se deseja ou não envolver a resposta em um envelope. | false |
includeRaw | booleano | Especifica se o documento ImportanteOs valores no documento | 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 |
---|---|---|
alertId | string | Identificador único do alerta associado a este evento. |
alertConfigId | string | Identificador único para a configuração de alerta associada ao alertId . |
apiKeyId | string | Identificador único da chave de API que acionou este evento. Se este campo estiver presente na resposta, o Ops Manager não retornará o campo |
clusterId | string | Identificador único do cluster ao qual este evento se aplica. |
clusterName | string | Nome do cluster ao qual este evento se aplica. |
collection | string | Nome da collection na qual o evento ocorreu. Este campo pode estar presente quando o eventTypeName é DATA_EXPLORER ou DATA_EXPLORER_CRUD . |
Criado | string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando esse evento foi acionado. |
currentValue | objeto | Valor atual da métrica que acionou este evento. |
currentValue .number | número | Valor da métrica. |
currentValue .units | string | Unidades relevantes para o valor. ExemploUma 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:
|
database | string | Nome do reconhecimento de data center no qual ocorreu o evento. Este campo pode estar presente quando o eventTypeName é DATA_EXPLORER ou DATA_EXPLORER_CRUD . |
eventTypeName | string | Nome da circunstância que acionou este evento. 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 em que este evento ocorreu. |
hostId | string | Identificador único do host no qual ocorreu este evento. |
nome do host | string | Nome do host, FQDN, endereço IPv4 ou endereço IPv6 do host no qual o evento ocorreu. |
id | string | Identificador único para este evento. |
isGlobalAdmin | booleano | Sinalizador que indica se o usuário que acionou esse evento tem a role Global Monitoring Administrator . |
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. Para valores possíveis, consulte abaixo. |
opType | string | Tipo de operação que gerou o evento. Este campo está presente quando eventTypeName é DATA_EXPLORER ou DATA_EXPLORER_CRUD . |
Porta | inteiro | Porta do host associado a este evento. |
chave pública | string | Chave pública associada à chave de API que acionou esse evento. Se este campo estiver presente na resposta, o Ops Manager não retornará o campo |
bruto | documento | Metainformações adicionais sobre o evento. Este campo aparece somente quando o parâmetro de query ImportanteOs valores no documento |
remotoAddress | string | Endereço IP associado ao usuário do Ops Manager (userId) que acionou o evento. |
ReplicaSetName | string | Nome do conjunto de réplicas. |
shardName | string | Nome do fragmento associado ao evento. |
targetPublicKey | string | Chave pública da chave API direcionada pelo evento. |
targetUsername | string | Nome de usuário do Ops Manager direcionado por este evento. |
teamId | string | Identificador único para a equipe do Ops Manager associado a este evento. |
ID do usuário | string | Identificador único para o usuário do Ops Manager que acionou este evento. Se este campo estiver presente na resposta, o Ops Manager não retornará o campo |
nome de usuário | string | Nome de usuário do Ops Manager que acionou este evento. Se este campo estiver presente na resposta, o Ops Manager não retornará o campo |
accessListEntry | string | Entrada da lista de acesso da chave API direcionada pelo evento. |
Exemplo de solicitação
curl --user "{publicKey}:{privateKey}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{orgId}/events/{eventId}?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 "alertConfigId": "{alertConfigId}", 3 "alertId": "{alertId}", 4 "clusterId": "{clusterId}", 5 "clusterName": "Test Cluster", 6 "created": "2018-06-11T12:34:56Z", 7 "currentValue": { 8 "number": 50, 9 "units": "RAW" 10 }, 11 "eventTypeName": "OUTSIDE_METRIC_THRESHOLD", 12 "groupId": "{groupId}", 13 "hostId": "{hostId}", 14 "hostname": "db.example.com", 15 "id": "{globalAlertId}", 16 "isGlobalAdmin": false, 17 "maintenanceWindowId": "{maintenanceWindowId}", 18 "metricName": "OPCOUNTER_CMD", 19 "orgId": "{orgId}", 20 "port": 27017, 21 "remoteAddress": "192.168.1.1", 22 "replicaSetName": "rs1", 23 "shardName": "sh1", 24 "userId": "{userId}", 25 "username": "john.doe@example.com", 26 "targetUsername": "jane.doe@example.com", 27 "teamId": "{teamId}" 28 }