Retornar um evento de uma organização

OBTER /api/atlas/v2/orgs/{orgId}/events/{eventId}
Contas de serviço DigestAuth

Retorna um evento para a organização especificada. Os eventos identificam atividades significativas de banco de dados, faturamento ou segurança, ou alterações de status. Para usar este recurso, a conta de serviço ou chave de API solicitante deve ter a função de membro da organização. Use o ponto de extremidade Retornar eventos de uma organização para recuperar todos os eventos aos quais o usuário autenticado tem acesso.

Este recurso permanece sob revisão e pode mudar.

Retornar eventos de uma organização

parâmetros de caminho

  • orgId string Obrigatório

    24String exclusiva de dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para recuperar todas as organizações às quais o usuário autenticado tem acesso.

    O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

  • eventId string Obrigatório

    String exclusiva de 24 dígitos hexadecimais que identifica o evento que você deseja retornar.

    O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

parâmetros de query

  • envelope booleano

    Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.

    O valor padrão é false.

  • pretty booleano

    Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

    O valor padrão é false.

    Prettyprint
  • includeRaw booleano

    Sinalizador que indica se o documento bruto deve ser incluído na saída. O documento bruto contém metainformações adicionais sobre o evento.

    O valor padrão é false.

Respostas

  • 200 application/vnd.atlas.2023-01-01+json

    OK

    Um dos seguintes:
    objeto DefaultEventViewForOrg objeto de AlertAudit objeto AlertConfigAudit ApiUserEventViewForOrg object objeto ServiceAccountOrgEvents BillingEventViewForOrg object NDSAuditViewForOrg object OrgEventViewForOrg object objeto TeamEvent objeto UserEventViewForOrg objeto ResourceEventViewForOrg objeto AtlasResourcePolicyAuditForOrg
  • 401 aplicação/json

    Não autorizado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.
  • 403 aplicação/json

    Forbidden.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.
  • 404 aplicação/json

    Não encontrado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.
  • 500 aplicação/json

    Erro interno do servidor.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.
GET /api/atlas/v2/orgs/{orgId}/events/{eventId} 
atlas api events getOrgEvent --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20231115001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.GetOrgEventApiParams{}
	sdkResp, httpResp, err := client.EventsApi.
		GetOrgEventWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-11-15+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-11-15+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true"
Exemplos de resposta (200) 
{
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "FEDERATION_SETTINGS_CREATED",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com"
}
{
  "alertId": "32b6e34b3d91647abb20e7b8",
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "ALERT_ACKNOWLEDGED_AUDIT",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com"
}
{
  "alertConfigId": "32b6e34b3d91647abb20e7b8",
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "ALERT_CONFIG_ADDED_AUDIT",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com"
}
{
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "API_KEY_CREATED",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "targetPublicKey": "zmmrboas",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com",
  "whitelistEntry": "0.0.0.0"
}
{
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "SERVICE_ACCOUNT_CREATED",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com"
}
{
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "CHARGE_SUCCEEDED",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "invoiceId": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "paymentId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com"
}
{
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "dbUserUsername": "user1",
  "eventTypeName": "ORG_LIMIT_UPDATED",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com",
  "whitelistEntry": "0.0.0.0"
}
{
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "ORG_CREATED",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "invoiceId": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com"
}
{
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "TEAM_ADDED_TO_GROUP",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "teamId": "32b6e34b3d91647abb20e7b8",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com"
}
{
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "JOINED_ORG",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "targetUsername": "test.user@mongodb.com",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com"
}
{
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "GROUP_TAGS_MODIFIED",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "resourceId": "32b6e34b3d91647abb20e7b8",
  "resourceType": "cluster",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com"
}
{
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "RESOURCE_POLICY_CREATED",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "resourcePolicyId": "32b6e34b3d91647abb20e7b8",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com"
}
Exemplos de resposta (401) 
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Exemplos de resposta (403) 
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Exemplos de resposta (404) 
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Exemplos de resposta (500) 
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}