Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/ / / /

Obter um evento de projeto

Nesta página

  • Funções obrigatórias
  • Solicitar
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

Sua chave de API deve ter a função Project Read Only para chamar esse recurso com êxito.

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

GET /groups/{groupId}/events/{eventId}
Nome
Tipo
Descrição

groupId

string

Identificador único do projeto associado ao evento desejado.

eventId

string

Identificador único do evento desejado.

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 raw deve ser incluído na saída. O documento raw contém metainformações adicionais sobre o evento.

Importante

Os valores no documento raw estão sujeitos a alterações. Não confie em valores raw para monitoramento oficial.

false

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

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 userId .

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.

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

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.

diffs

Array de objetos

Alterações feitas na implantação durante este evento.

Observação

O Ops Manager retorna elementos diferentes dependendo do que foi alterado: privilégios ou roles de usuário, trabalhos de restauração, módulos de automação e assim por diante. A lista desta array e seus objetos não é exaustiva.

diffs
.id

string

Identificador único para as diferenças executadas neste evento.

diffs
.params

Array de objetos

collection de alterações feitas no recurso fornecido.

diffs
.params
.display

string

Etiqueta exibida no console no feed de atividades quando a alteração foi feita.

diffs
.params
.new

string

Novo estado do parâmetro que foi alterado.

diffs
.params
.old

string

Estado inicial do parâmetro que foi alterado.

diffs
.params
.param

string

Nome do parâmetro que foi alterado.

diffs
.status

string

Tipo de alteração feita nesse recurso.

  • NEW

  • MODIFIED

  • REMOVED

  • SHUTDOWN

  • STARTUP

  • RESTORE

  • RESTART

diffs
.type

string

Recurso para o qual a alteração foi feita.

  • AUTH

  • AUTOMATION_AGENT

  • BACKUP_AGENT

  • BI_CONNECTOR

  • MONITORING_AGENT

  • PROCESS

  • REPLICA_SET

  • ROLES

  • USERS

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 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.

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 username .

bruto

documento

Metainformações adicionais sobre o evento. Este campo aparece somente quando o parâmetro de query includeRaw é true.

Importante

Os valores no documento raw estão sujeitos a alterações. Não confie em valores raw para monitoramento oficial.

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 apiKeyId .

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 publicKey .

accessListEntry

string

Entrada da lista de acesso da chave API direcionada pelo evento.

curl --user "{publicKey}:{privateKey}" --digest \
--header "Accept: application/json" \
--include \
--request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{groupId}/events/{eventId}?pretty=true"
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}
1{
2 "created" : "2020-07-13T21:28:37Z",
3 "diffs" : [ {
4 "id" : "admin@admin",
5 "name" : null,
6 "params" : [ {
7 "display" : "Added Privilege",
8 "new" : "config.system.sessions: moveChunk",
9 "old" : null,
10 "param" : "config.system.sessions: moveChunk"
11 }, {
12 "display" : "Added Privilege",
13 "new" : "config.system.sessions: splitChunk",
14 "old" : null,
15 "param" : "config.system.sessions: splitChunk"
16 }, {
17 "display" : "Added Privilege",
18 "new" : "config.system.sessions: splitVector",
19 "old" : null,
20 "param" : "config.system.sessions: splitVector"
21 } ],
22 "priviileges" : [ {
23 "actions" : [ "moveChunk" ],
24 "resource" : {
25 "collection" : "system.sessions",
26 "db" : "config"
27 }
28 }, {
29 "actions" : [ "moveChunk" ],
30 "resource" : {
31 "collection" : "",
32 "db" : ""
33 }
34 }, {
35 "actions" : [ "enableSharding" ],
36 "resource" : {
37 "cluster" : true
38 }
39 }, {
40 "actions" : [ "cleanupOrphaned" ],
41 "resource" : {
42 "cluster" : true
43 }
44 }, {
45 "actions" : [ "flushRouterConfig" ],
46 "resource" : {
47 "cluster" : true
48 }
49 }, {
50 "actions" : [ "splitChunk" ],
51 "resource" : {
52 "collection" : "system.sessions",
53 "db" : "config"
54 }
55 }, {
56 "actions" : [ "splitChunk" ],
57 "resource" : {
58 "collection" : "",
59 "db" : ""
60 }
61 }, {
62 "actions" : [ "splitVector" ],
63 "resource" : {
64 "collection" : "system.sessions",
65 "db" : "config"
66 }
67 }, {
68 "actions" : [ "viewRole" ],
69 "resource" : {
70 "collection" : "",
71 "db" : ""
72 }
73 } ],
74 "roles" : [ {
75 "db" : "admin",
76 "role" : "readWriteAnyDatabase"
77 }, {
78 "db" : "admin",
79 "role" : "dbAdminAnyDatabase"
80 }, {
81 "db" : "admin",
82 "role" : "enableSharding"
83 }, {
84 "db" : "admin",
85 "role" : "backup"
86 }, {
87 "db" : "admin",
88 "role" : "clusterMonitor"
89 } ],
90 "status" : "MODIFIED",
91 "type" : "ROLES"
92 }
93}

Voltar

Obter tudo (projeto)