Obter uma assinatura de evento

OBTER /groups/{groupId}/apps/{appId}/event_subscriptions/{eventSubscriptionId}

tokenAuth

Retornar informações sobre uma assinatura de evento.

parâmetros de caminho

groupId string Obrigatório

Uma ID de projeto/grupo do Atlas.
appId string Obrigatório

O ObjectID do seu aplicativo. A seção de ID de projeto e aplicativo do App Services API mostra como localizar esse valor.
eventSubscriptionId string Obrigatório

O valor _id único de uma inscrição de evento.

Respostas

200 aplicação/json

Sucesso.
Uma assinatura de um evento stream.
Um dos seguintes:
DatabaseTrigger object objeto AuthenticationTrigger objeto ScheduledTrigger objeto EventSubscription
Ocultar atributos Mostrar atributos

_id string

ID exclusivo do trigger.

name string Obrigatório

O nome do trigger.

type string Obrigatório

O tipo de acionador. Para acionadores de banco de dados, esse valor é sempre "DATABASE".

O valor é DATABASE.

desabilitado booleano

Se true, o acionador será desabilitado e não escutará eventos nem será executado.

O valor padrão é false.

config objeto Obrigatório

Um objeto que define valores de configuração para o trigger.

Ocultar atributos de configuração Mostrar atributos de configuração objeto

service_id string Obrigatório

O valor _id de uma fonte de dados MongoDB vinculada que contém a coleção assistida.

Você pode listar serviços com o endpoint Obter todos os serviços.

As fontes de dados são serviços cujo type é "mongodb-atlas". Use o valor _id para a fonte de dados que você deseja vincular ao trigger.

database string

O nome de um banco de dados na fonte de dados vinculada. Se você omitir este parâmetro, o Tipo de Origem será alterado para "Sistema". No entanto, a infraestrutura de camada compartilhada não suporta changestreams de implantação. Se você omitir o parâmetro "banco de dados", receberá o erro " os changestreams de implantação não são suportados em clusters de camada compartilhada ". Forneça o parâmetro do banco de dados para resolver esse erro.

collection string

O nome de uma collection no banco de dados especificado. O trigger escuta eventos desta coleção. Se você omitir este parâmetro, o Tipo de Origem será alterado para "Banco de Dados".

operation_types array[string] Obrigatório

Os tipos de evento de alteração MongoDB que o trigger escuta.

Os tipos de operação válidos para todos os triggers incluem:

"INSERT"

"UPDATE"

"REPLACE"

"DELETE"

Tipos de operação válidos adicionais para gatilhos de banco de dados e implantação incluem:

"CREATE_COLLECTION"

"MODIFY_COLLECTION"

"RENAME_COLLECTION"

"DROP_COLLECTION"

"SHARD_COLLECTION"

"RESHARD_COLLECTION"

"REFINE_COLLECTION_SHARD_KEY"

Tipos de operação válidos adicionais para gatilhos de implantação incluem:

"DROP_DATABASE"

Para obter mais informações, consulte Configuração do trigger.

Pelo menos 1 elemento.

corresponder objeto

Uma expressão $match filtra eventos de alteração. O trigger só será acionado se a expressão for avaliada como verdadeira para um determinado evento de alteração .

projeto, projeto objeto

Uma expressão de $projeto retorna somente os campos especificados. Você pode incluir ou excluir campos específicos ou incluir campos recém-computados.

full_document booleano

Se true, indica que UPDATE eventos de alteração devem incluir a versão mais atual confirmada por maioria do documento modificado no campo fullDocument.

O valor padrão é false.

full_document_before_change booleano

Se true, indica que UPDATE eventos de alteração devem incluir um snapshot do documento modificado imediatamente antes de a atualização ser aplicada.

Você deve habilitar pré-imagens de documento para seu cluster incluir esses snapshots.

O valor padrão é false.

skip_catchup_events booleano

Se true, habilitar o trigger depois que ele foi desabilitado não invocará eventos que ocorreram enquanto o trigger estava desabilitado.

O valor padrão é false.

tolerate_resume_errors booleano

Se true, quando o token de retomada desse trigger não puder ser encontrado no oplog do cluster, o trigger retomará automaticamente os eventos de processamento no próximo evento relevante de change streams. Todos os eventos de change streams, desde quando o trigger foi suspenso até que o trigger retome a execução, não têm o trigger acionado para eles.

O valor padrão é false.

maximum_throughput booleano

Se true, o trigger usará a opção de maximizar a taxa de transferência.

O valor padrão é false.

Não ordenado booleano

Se true, a ordenação de evento estará desabilitada e este trigger poderá processar eventos em paralelo. Se false, a ordenação de evento está habilitada e o trigger executa eventos em série.

O valor padrão é false.

function_id string

A ID da função que o trigger chama quando é disparado.

Este valor é o mesmo que event_processors.FUNCTION.function_id. Você pode definir o valor aqui ou em event_processors.FUNCTION.function_id. O backend do App Services duplica o valor para o local de configuração onde você não o definiu.

Por exemplo, se você definir function_id, o backend o duplicará para event_processors.FUNCTION.function_id.

Se você definir function_id, event_processors não será necessário. Você deve fornecer function_id ou event_processors ao atualizar um trigger.

function_name string

O nome da função que o trigger chama quando é acionado, ou seja, a função descrita por function_id.

Este valor é o mesmo que event_processors.FUNCTION.function_name. Você pode definir o valor aqui ou em event_processors.FUNCTION.function_name. O backend do App Services duplica o valor para o local de configuração onde você não o definiu.

Por exemplo, se você definir function_name, o backend o duplicará para event_processors.FUNCTION.function_name.

Se você definir function_name, event_processors não será necessário. Você deve fornecer function_name ou event_processors ao atualizar um trigger.

event_processors objeto Obrigatório

Um objeto em que cada nome de campo é um ID de processador de eventos e cada valor é um objeto que configura o processador de eventos correspondente. Para ver um exemplo de objeto de configuração, consulte Enviar eventos de trigger para o AWS EventBridge.

Ocultar atributos event_processors Mostrar atributos event_processors objeto

Função objeto

Ocultar atributo FUNCTION Mostrar atributo FUNCTION objeto

config objeto

Ocultar atributos de configuração Mostrar atributos de configuração objeto

function_id string

A ID da função que o trigger chama quando é disparado.

Este valor é o mesmo que o function_id de nível raiz. Você pode definir o valor aqui ou em function_id. O backend do App Services duplica o valor para o local de configuração onde você não o definiu.

Por exemplo, se você definir event_processors.FUNCTION.function_id, o backend o duplicará para function_id.

Se você definir function_id, event_processors não será necessário. Você deve fornecer function_id ou event_processors ao atualizar um trigger.

function_name string

O nome da função que o trigger chama quando é acionado, ou seja, a função descrita por function_id.

Este valor é o mesmo que o function_name de nível raiz. Você pode definir o valor aqui ou em function_name. O backend do App Services duplica o valor para o local de configuração onde você não o definiu.

Por exemplo, se você definir event_processors.FUNCTION.function_name, o backend o duplicará para function_name.

Se você definir function_name, event_processors não será necessário. Você deve fornecer function_name ou event_processors ao atualizar um trigger.

AWS_Eventbridge objeto

Ocultar atributo AWS_EVENTBRIDGE Mostrar atributo AWS_EVENTBRIDGE objeto

config objeto

Ocultar atributos de configuração Mostrar atributos de configuração objeto

account_id string

Um ID de conta do Amazon Web Services.

região string

Uma região Amazon Web Services.

Extended_json_enabled booleano

Se true, os objetos de evento serão serializados usando EJSON.

O valor padrão é false.

error_andler objeto

Um objeto que define o tratamento de erros personalizado para um trigger do Amazon Web Services Eventbridge. Válido somente para Atlas Triggers de tipo "DATABASE" com processadores de evento "AWS_EVENTBRIDGE" .

Ocultar atributo error_handler Mostrar atributo error_handler objeto

config objeto

Ocultar atributos de configuração Mostrar atributos de configuração objeto

habilitado booleano

Se "true", o tratamento de erros personalizado está ativado para o trigger do AWS Eventbridge.

function_id string

O ID da função invocada quando o trigger do AWS Eventbridge falha e não pode ser repetido com êxito.
Ocultar atributos Mostrar atributos

_id string

ID exclusivo do trigger.

name string Obrigatório

O nome do trigger.

type string Obrigatório

O tipo de acionador. Para acionadores de autenticação, esse valor é sempre "AUTHENTICATION".

O valor é AUTHENTICATION.

desabilitado booleano

Se true, o acionador será desabilitado e não escutará eventos nem será executado.

O valor padrão é false.

config objeto Obrigatório

Um objeto que define valores de configuração para o trigger.

Ocultar atributos de configuração Mostrar atributos de configuração objeto

operation_type string Obrigatório

O tipo de evento de autenticação que o trigger escuta.

Os valores são LOGIN, CREATE ou DELETE.

providers string Obrigatório

O(s) tipo(s) de provedor de autenticação que o trigger escuta.

Os valores são anon-user, api-key, custom-token, custom-function, local-userpass, oauth2-apple, oauth2-facebook ou oauth2-google.

function_id string

A ID da função que o trigger chama quando é disparado.

Este valor é o mesmo que event_processors.FUNCTION.function_id. Você pode definir o valor aqui ou em event_processors.FUNCTION.function_id. O backend do App Services duplica o valor para o local de configuração onde você não o definiu.

Por exemplo, se você definir function_id, o backend o duplicará para event_processors.FUNCTION.function_id.

Se você definir function_id, event_processors não será necessário. Você deve fornecer function_id ou event_processors ao atualizar um trigger.

function_name string

O nome da função que o trigger chama quando é acionado, ou seja, a função descrita por function_id.

Este valor é o mesmo que event_processors.FUNCTION.function_name. Você pode definir o valor aqui ou em event_processors.FUNCTION.function_name. O backend do App Services duplica o valor para o local de configuração onde você não o definiu.

Por exemplo, se você definir function_name, o backend o duplicará para event_processors.FUNCTION.function_name.

Se você definir function_name, event_processors não será necessário. Você deve fornecer function_name ou event_processors ao atualizar um trigger.

event_processors objeto Obrigatório

Um objeto em que cada nome de campo é um ID de processador de eventos e cada valor é um objeto que configura o processador de eventos correspondente. Para ver um exemplo de objeto de configuração, consulte Enviar eventos de trigger para o AWS EventBridge.

Ocultar atributos event_processors Mostrar atributos event_processors objeto

Função objeto

Ocultar atributo FUNCTION Mostrar atributo FUNCTION objeto

config objeto

Ocultar atributos de configuração Mostrar atributos de configuração objeto

function_id string

A ID da função que o trigger chama quando é disparado.

Este valor é o mesmo que o function_id de nível raiz. Você pode definir o valor aqui ou em function_id. O backend do App Services duplica o valor para o local de configuração onde você não o definiu.

Por exemplo, se você definir event_processors.FUNCTION.function_id, o backend o duplicará para function_id.

Se você definir function_id, event_processors não será necessário. Você deve fornecer function_id ou event_processors ao atualizar um trigger.

function_name string

O nome da função que o trigger chama quando é acionado, ou seja, a função descrita por function_id.

Este valor é o mesmo que o function_name de nível raiz. Você pode definir o valor aqui ou em function_name. O backend do App Services duplica o valor para o local de configuração onde você não o definiu.

Por exemplo, se você definir event_processors.FUNCTION.function_name, o backend o duplicará para function_name.

Se você definir function_name, event_processors não será necessário. Você deve fornecer function_name ou event_processors ao atualizar um trigger.

AWS_Eventbridge objeto

Ocultar atributo AWS_EVENTBRIDGE Mostrar atributo AWS_EVENTBRIDGE objeto

config objeto

Ocultar atributos de configuração Mostrar atributos de configuração objeto

account_id string

Um ID de conta do Amazon Web Services.

região string

Uma região Amazon Web Services.

Extended_json_enabled booleano

Se true, os objetos de evento serão serializados usando EJSON.

O valor padrão é false.
Ocultar atributos Mostrar atributos

_id string

ID exclusivo do trigger.

name string Obrigatório

O nome do trigger.

type string Obrigatório

O tipo de acionador. Para acionadores programados, esse valor é sempre "SCHEDULED".

O valor é SCHEDULED.

desabilitado booleano

Se true, o acionador será desabilitado e não escutará eventos nem será executado.

O valor padrão é false.

config objeto Obrigatório

Um objeto que define valores de configuração para o trigger.

Ocultar atributos de configuração Mostrar atributos de configuração objeto

agendamento string Obrigatório

Uma expressão cron que especifica quando o trigger é executado.

skip_catchup_events booleano

Se true, habilitar o trigger depois que ele foi desabilitado não invocará eventos que ocorreram enquanto o trigger estava desabilitado.

function_id string

A ID da função que o trigger chama quando é disparado.

Este valor é o mesmo que event_processors.FUNCTION.function_id. Você pode definir o valor aqui ou em event_processors.FUNCTION.function_id. O backend do App Services duplica o valor para o local de configuração onde você não o definiu.

Por exemplo, se você definir function_id, o backend o duplicará para event_processors.FUNCTION.function_id.

Se você definir function_id, event_processors não será necessário. Você deve fornecer function_id ou event_processors ao atualizar um trigger.

function_name string

O nome da função que o trigger chama quando é acionado, ou seja, a função descrita por function_id.

Este valor é o mesmo que event_processors.FUNCTION.function_name. Você pode definir o valor aqui ou em event_processors.FUNCTION.function_name. O backend do App Services duplica o valor para o local de configuração onde você não o definiu.

Por exemplo, se você definir function_name, o backend o duplicará para event_processors.FUNCTION.function_name.

Se você definir function_name, event_processors não será necessário. Você deve fornecer function_name ou event_processors ao atualizar um trigger.

event_processors objeto Obrigatório

Um objeto em que cada nome de campo é um ID de processador de eventos e cada valor é um objeto que configura o processador de eventos correspondente. Para ver um exemplo de objeto de configuração, consulte Enviar eventos de trigger para o AWS EventBridge.

Ocultar atributos event_processors Mostrar atributos event_processors objeto

Função objeto

Ocultar atributo FUNCTION Mostrar atributo FUNCTION objeto

config objeto

Ocultar atributos de configuração Mostrar atributos de configuração objeto

function_id string

A ID da função que o trigger chama quando é disparado.

Este valor é o mesmo que o function_id de nível raiz. Você pode definir o valor aqui ou em function_id. O backend do App Services duplica o valor para o local de configuração onde você não o definiu.

Por exemplo, se você definir event_processors.FUNCTION.function_id, o backend o duplicará para function_id.

Se você definir function_id, event_processors não será necessário. Você deve fornecer function_id ou event_processors ao atualizar um trigger.

function_name string

O nome da função que o trigger chama quando é acionado, ou seja, a função descrita por function_id.

Este valor é o mesmo que o function_name de nível raiz. Você pode definir o valor aqui ou em function_name. O backend do App Services duplica o valor para o local de configuração onde você não o definiu.

Por exemplo, se você definir event_processors.FUNCTION.function_name, o backend o duplicará para function_name.

Se você definir function_name, event_processors não será necessário. Você deve fornecer function_name ou event_processors ao atualizar um trigger.

AWS_Eventbridge objeto

Ocultar atributo AWS_EVENTBRIDGE Mostrar atributo AWS_EVENTBRIDGE objeto

config objeto

Ocultar atributos de configuração Mostrar atributos de configuração objeto

account_id string

Um ID de conta do Amazon Web Services.

região string

Uma região Amazon Web Services.

Extended_json_enabled booleano

Se true, os objetos de evento serão serializados usando EJSON.

O valor padrão é false.
Ocultar atributos Mostrar atributos

_id string

name string

type string

O valor é SYNCTRANSLATOR.

function_id string

desabilitado booleano

config zero

last_modified número

GET /groups/{groupId}/apps/{appId}/event_subscriptions/{eventSubscriptionId}

curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/event_subscriptions/{eventSubscriptionId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Exemplos de resposta (200)

{
  "name": "onNewEmployee",
  "type": "DATABASE",
  "config": {
    "match": {},
    "project": {},
    "database": "HR",
    "collection": "employees",
    "service_id": "5adeb649b8b998486770ae7c",
    "full_document": true,
    "operation_types": [
      "INSERT"
    ]
  },
  "function_id": "5eea9ca4ca0e356e2c2a148a",
  "event_processors": {
    "FUNCTION": {
      "config": {
        "function_id": "6841b8d3e71dc81bed89dbba",
        "function_name": "Atlas_Triggers_DatabaseInsert_1749137618"
      }
    }
  }
}

{
  "name": "onNewApiKey",
  "type": "AUTHENTICATION",
  "config": {
    "providers": [
      "api-key"
    ],
    "operation_type": "CREATE"
  },
  "function_id": "5eea9ca4ca0e356e2c2a148a",
  "event_processors": {
    "FUNCTION": {
      "config": {
        "function_id": "6841b8d3e71dc81bed89dbba",
        "function_name": "Atlas_Triggers_Auth_Create_1749137618"
      }
    }
  }
}

{
  "name": "createDailyReport",
  "type": "SCHEDULED",
  "config": {
    "schedule": "0 8 * * *"
  },
  "function_id": "5eea9ca4ca0e356e2c2a148a",
  "event_processors": {
    "FUNCTION": {
      "config": {
        "function_id": "6841b8d3e71dc81bed89dbba",
        "function_name": "Atlas_Triggers_Monthly_1749137618"
      }
    }
  }
}

{
  "_id": "636c189a93daaf89c4900a81",
  "name": "SyncTranslator",
  "type": "SYNCTRANSLATOR",
  "config": null,
  "disabled": false,
  "function_id": "000000000000000000000000",
  "last_modified": 1668028570
}