Menu Docs
Página inicial do Docs
/
MongoDB Cloud Manager
/
API
/
Recursos
/
Medições e alertas
/
Eventos

Obter todos os eventos da organização

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
  • documento de resposta
  • results documento incorporado
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

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://cloud.mongodb.com/api/public/v1.0

GET /orgs/{orgId}/events

Parâmetros do caminho da solicitação

Este endpoint não usa parâmetros de caminho de solicitação HTTP.

Solicitar parâmetros de query

Parâmetros de query únicos

Esse endpoint aceita os seguintes parâmetros de query para filtrar eventos retornados:

Nome
Tipo
Descrição
Default
eventType
string

Retornar apenas eventos dos tipos especificados.

Para revisar os tipos de eventos que geram alertas, consulte Tipos de Alerta.

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
minDate
string
Retornar apenas eventos para os quais a data criada é maior ou igual ao Registro de data/hora especificado na ISO formato de data e hora em 8601 UTC.
maxDate
string
Retornar apenas eventos para os quais a data criada é menor ou igual ao Registro de data/hora especificado na ISO formato de data 8601 e hora em UTC.

Parâmetros de query comuns

Esse endpoint também aceita os parâmetros de query comuns a todos os endpoints que retornam listas de valores:

Nome
Tipo
Descrição
Default
pageNum
inteiro
Número da página (com base em índice 1).
1
itemsPerPage
inteiro
Número de itens a serem devolvidos por página, até um máximo de 500.
100
pretty
booleano
Indica se o corpo da resposta deve estar em formato prettyprint.
false
envelope
booleano

Indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure "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

Para endpoints que retornam uma lista de resultados, o objeto results é um envelope. O Cloud Manager adiciona o campo status ao corpo da resposta.

none

Parâmetros do corpo da solicitação

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

Resposta

documento de resposta

O documento JSON de resposta inclui uma array de objetos result , uma array de objetos link e uma contagem do número total de objetos result recuperados.

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

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 esse campo estiver presente na resposta, o Cloud Manager não retornará o campo userId .

clusterId
string
ID do cluster ao qual esse 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.

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

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.

groupId
string
ID do projeto em que esse evento ocorreu.
hostId
string
ID do host no qual esse evento ocorreu.
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.
invoiceId
string
Identificador único da fatura associada a este evento.
isGlobalAdmin
booleano
Sinalizador que indica se o usuário que acionou esse evento é um funcionário do MongoDB.
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.

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.
deploymentId
string
Identificador único do pagamento da fatura associado a este evento.
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 esse campo estiver presente na resposta, o Cloud 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 Cloud Manager (userId) que acionou o evento.
ReplicaSetName
string
Nome do conjunto de réplicas.
shardName
string
O nome do fragmento associado ao evento.
targetPublicKey
string
Chave pública da chave API direcionada pelo evento.
targetUsername
string
Nome de usuário do usuário do Cloud Manager segmentado por este evento.
teamId
string
Identificador único da equipe do Cloud Manager associada a este evento.
ID do usuário
string

Identificador único para o usuário do Cloud Manager que acionou este evento.

Se esse campo estiver presente na resposta, o Cloud Manager não retornará o campo apiKeyId .

nome de usuário
string

Nome de usuário do Cloud Manager que acionou esse evento.

Se esse campo estiver presente na resposta, o Cloud Manager não retornará o campo publicKey .

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://cloud.mongodb.com/api/public/v1.0/orgs/{orgId}/events?pretty=true"

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

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  "invoiceId": "{invoiceId}",
17  "isGlobalAdmin": false,
18  "maintenanceWindowId": "{maintenanceWindowId}",
19  "metricName": "OPCOUNTER_CMD",
20  "orgId": "{orgId}",
21  "paymentId": "{paymentId}",
22  "port": 27017,
23  "remoteAddress": "192.168.1.1",
24  "replicaSetName": "rs1",
25  "shardName": "sh1",
26  "userId": "{userId}",
27  "username": "john.doe@example.com",
28  "targetUsername": "jane.doe@example.com",
29  "teamId": "{teamId}"
30}

Voltar

Eventos

Próximo

Obter um (Organização)