Retornar informações sobre uma assinatura de evento.
Uma ID de projeto/grupo do Atlas.
O ObjectID do seu aplicativo. A seção de ID de projeto e aplicativo do App Services API mostra como localizar esse valor.
O valor _id único de uma inscrição de evento.
Sucesso.
Uma assinatura de um evento stream.
ID exclusivo do trigger.
O nome do trigger.
O tipo de acionador. Para acionadores de banco de dados, esse valor é sempre "DATABASE".
O valor é DATABASE.
Se true, o acionador será desabilitado e não escutará eventos nem será executado.
O valor padrão é false.
Um objeto que define valores de configuração para o trigger.
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.
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.
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".
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.
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 .
Uma expressão de $projeto retorna somente os campos especificados. Você pode incluir ou excluir campos específicos ou incluir campos recém-computados.
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.
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.
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.
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.
Se true, o trigger usará a opção de maximizar a taxa de transferência.
O valor padrão é false.
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.
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.
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.
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.
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.
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.
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" .
ID exclusivo do trigger.
O nome do trigger.
O tipo de acionador. Para acionadores de autenticação, esse valor é sempre "AUTHENTICATION".
O valor é AUTHENTICATION.
Se true, o acionador será desabilitado e não escutará eventos nem será executado.
O valor padrão é false.
Um objeto que define valores de configuração para o trigger.
O tipo de evento de autenticação que o trigger escuta.
Os valores são LOGIN, CREATE ou DELETE.
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.
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.
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.
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.
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.
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.
ID exclusivo do trigger.
O nome do trigger.
O tipo de acionador. Para acionadores programados, esse valor é sempre "SCHEDULED".
O valor é SCHEDULED.
Se true, o acionador será desabilitado e não escutará eventos nem será executado.
O valor padrão é false.
Um objeto que define valores de configuração para o trigger.
Uma expressão cron que especifica quando o trigger é executado.
Se true, habilitar o trigger depois que ele foi desabilitado não invocará eventos que ocorreram enquanto o trigger estava desabilitado.
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.
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.
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.
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.
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.
curl \
--request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/event_subscriptions/{eventSubscriptionId}' \
--header "Authorization: Bearer $ACCESS_TOKEN"{
"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
}