Obter todos os eventos do projeto
Nesta página
- A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.
- O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .
Funções obrigatórias
Sua chave de API deve ter a função Project Read Only
para chamar esse recurso com êxito.
Solicitar
URL base: https://cloud.mongodb.com/api/public/v1.0
GET /groups/{groupId}/events
Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
---|---|---|
groupId | string | Identificador único do projeto associado ao evento desejado. |
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 IMPORTANTE: os valores no documento |
|
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). |
| ||||||
itemsPerPage | inteiro | Número de itens a serem devolvidos por página, até um máximo de 500. |
| ||||||
pretty | booleano | Indica se o corpo da resposta deve estar em formato prettyprint. |
| ||||||
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 Para endpoints que retornam um resultado, o corpo da resposta inclui:
Para endpoints que retornam uma lista de resultados, o objeto | 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 |
---|---|---|
| array | A array inclui um objeto para cada item detalhado na seção |
| 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. |
| 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 |
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 |
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 |
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:
|
database | string | Nome do reconhecimento de data center no qual ocorreu o evento. Este campo pode estar presente quando o |
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 |
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 |
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 |
bruto | documento | Metainformações adicionais sobre o evento. Este campo aparece somente quando o parâmetro de query IMPORTANTE: os valores no documento |
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 |
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 |
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/groups/{groupId}/events?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 "links" : [ { 3 "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{groupId}/events?pretty=true&pageNum=1&itemsPerPage=100", 4 "rel" : "self" 5 }, { 6 "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{groupId}/events?pretty=true&itemsPerPage=100&pageNum=2", 7 "rel" : "next" 8 } ], 9 "results" : [ { 10 "created" : "2020-07-13T21:28:37Z", 11 "diffs" : [ { 12 "id" : "admin@admin", 13 "name" : null, 14 "params" : [ { 15 "display" : "Added Privilege", 16 "new" : "config.system.sessions: moveChunk", 17 "old" : null, 18 "param" : "config.system.sessions: moveChunk" 19 }, { 20 "display" : "Added Privilege", 21 "new" : "config.system.sessions: splitChunk", 22 "old" : null, 23 "param" : "config.system.sessions: splitChunk" 24 }, { 25 "display" : "Added Privilege", 26 "new" : "config.system.sessions: splitVector", 27 "old" : null, 28 "param" : "config.system.sessions: splitVector" 29 } ], 30 "priviileges" : [ { 31 "actions" : [ "moveChunk" ], 32 "resource" : { 33 "collection" : "system.sessions", 34 "db" : "config" 35 } 36 }, { 37 "actions" : [ "moveChunk" ], 38 "resource" : { 39 "collection" : "", 40 "db" : "" 41 } 42 }, { 43 "actions" : [ "enableSharding" ], 44 "resource" : { 45 "cluster" : true 46 } 47 }, { 48 "actions" : [ "cleanupOrphaned" ], 49 "resource" : { 50 "cluster" : true 51 } 52 }, { 53 "actions" : [ "flushRouterConfig" ], 54 "resource" : { 55 "cluster" : true 56 } 57 }, { 58 "actions" : [ "splitChunk" ], 59 "resource" : { 60 "collection" : "system.sessions", 61 "db" : "config" 62 } 63 }, { 64 "actions" : [ "splitChunk" ], 65 "resource" : { 66 "collection" : "", 67 "db" : "" 68 } 69 }, { 70 "actions" : [ "splitVector" ], 71 "resource" : { 72 "collection" : "system.sessions", 73 "db" : "config" 74 } 75 }, { 76 "actions" : [ "viewRole" ], 77 "resource" : { 78 "collection" : "", 79 "db" : "" 80 } 81 } ], 82 "roles" : [ { 83 "db" : "admin", 84 "role" : "readWriteAnyDatabase" 85 }, { 86 "db" : "admin", 87 "role" : "dbAdminAnyDatabase" 88 }, { 89 "db" : "admin", 90 "role" : "enableSharding" 91 }, { 92 "db" : "admin", 93 "role" : "backup" 94 }, { 95 "db" : "admin", 96 "role" : "clusterMonitor" 97 } ], 98 "status" : "MODIFIED", 99 "type" : "ROLES" 100 }, { 101 "id" : "sample-dataset-load@admin", 102 "name" : null, 103 "params" : [ ], 104 "priviileges" : null, 105 "roles" : [ { 106 "db" : "admin", 107 "role" : "readWriteAnyDatabase" 108 } ], 109 "status" : "NEW", 110 "type" : "USERS" 111 }, { 112 "id" : "10.16.0.6482-1", 113 "name" : null, 114 "params" : [ { 115 "display" : "Version", 116 "new" : "10.16.0.6482-1", 117 "old" : "10.12.0.6179-1", 118 "param" : "version" 119 } ], 120 "status" : "MODIFIED", 121 "type" : "AUTOMATION_AGENT" 122 } ], 123 "eventTypeName" : "AUTOMATION_CONFIG_PUBLISHED_AUDIT", 124 "groupId" : "{groupId}", 125 "id" : "{eventId}", 126 "isGlobalAdmin" : false, 127 "links" : [ { 128 "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{groupId}/events/{eventId}", 129 "rel" : "self" 130 } ] 131 }], 132 "totalCount" : 1 133 }