Devolver información sobre una suscripción a un evento.
Parámetros de ruta
-
Un ID de proyecto/grupo Atlas.
-
El ObjectID de tu aplicación. La sección de ID de Proyecto y ID de la aplicación de App Services API muestra cómo encontrar este valor.
-
El valor único
_idde una suscripción a un evento.
Respuestas
-
Éxito.
Una suscripción a un flujo de eventos de cambio.
Uno de: Ocultar atributos Mostrar atributos
-
Identificador único del disparador.
-
El nombre del activador.
-
El tipo de disparador. Para los disparadores de base de datos, este valor siempre es
"DATABASE".El valor es
DATABASE. -
Si es
true, el disparador está deshabilitado y no escucha eventos ni se ejecuta.El valor predeterminado es
false. -
Un objeto que define valores de configuración para el disparador.
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
-
El valor
_idde una fuente de datos MongoDB vinculada que contiene la colección observada.Puede enumerar servicios con el punto final Obtener todos los servicios.
Las fuentes de datos son servicios cuyo valor
typees "mongodb-atlas". Use el valor_idpara la fuente de datos que desea vincular al disparador. -
El nombre de una base de datos en la fuente de datos vinculada. Si omite este parámetro, el tipo de origen cambia a "Implementación". Sin embargo, la infraestructura de nivel compartido no admite flujos de cambios de implementación. Si omite el parámetro "database", recibirá el error "Los flujos de cambios de implementación no son compatibles con los clústeres de nivel compartido". Proporcione el parámetro "database" para resolver este error.
-
El nombre de una colección en la base de datos especificada. El disparador escucha eventos de esta colección. Si se omite este parámetro, el tipo de origen cambia a "Base de datos".
-
Los tipos de eventos de cambio de MongoDB que el disparador escucha.
Los tipos de operación válidos para todos los activadores incluyen:
"INSERT""UPDATE""REPLACE""DELETE"
Los tipos de operaciones válidos adicionales para desencadenadores de bases de datos e implementación incluyen:
"CREATE_COLLECTION""MODIFY_COLLECTION""RENAME_COLLECTION""DROP_COLLECTION""SHARD_COLLECTION""RESHARD_COLLECTION""REFINE_COLLECTION_SHARD_KEY"
Los tipos de operaciones válidos adicionales para los activadores de implementación incluyen:
"DROP_DATABASE"
Para más información, consulta Configuración de activadores.
Al menos
1elemento. -
Una expresión $match filtra eventos de cambio. El disparador solo se activará si la expresión se evalúa como verdadera para un evento de cambio determinado.
-
Una expresión $project devuelve solo los campos especificados. Puede incluir o excluir campos específicos, o incluir campos recién calculados.
-
Si
truees, indica queUPDATEeventos de cambio deben incluir la versión más actual y mayoritariamente comprometida del documento modificado en elfullDocumentcampo.El valor predeterminado es
false. -
Si es verdadero, indica que
UPDATEeventos de cambio deben incluir una instantánea del documento modificado inmediatamente antes de que se aplicara la actualización.Debe habilitar las preimágenes de documentos para su clúster para incluir estas instantáneas.
El valor predeterminado es
false. -
Si es
true, habilitar el disparador después de haberlo deshabilitado no invocará eventos que ocurrieron mientras el disparador estaba deshabilitado.El valor predeterminado es
false. -
Si
true, cuando no se encuentra el token de reanudación de este disparador en el registro de operaciones del clúster, este reanuda automáticamente el procesamiento de eventos en el siguiente evento relevante del flujo de cambios. Todos los eventos del flujo de cambios desde que se suspendió el disparador hasta que este reanude su ejecución no se activan.El valor predeterminado es
false. -
Si
truees, el disparador utilizará la opción de maximizar el rendimiento.El valor predeterminado es
false. -
Si es
true, la ordenación de eventos está deshabilitada y este disparador puede procesar eventos en paralelo. Si esfalse, la ordenación de eventos está habilitada y el disparador ejecuta eventos en serie.El valor predeterminado es
false.
-
-
El ID de la función que el disparador llama cuando se activa.
Este valor es igual a
event_processors.FUNCTION.function_id. Puede definirlo aquí o enevent_processors.FUNCTION.function_id. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
function_id, el backend lo duplica enevent_processors.FUNCTION.function_id.Si define
function_id,event_processorsno es obligatorio. Debe proporcionarfunction_idoevent_processorsal actualizar un disparador. -
El nombre de la función que el disparador llama cuando se activa, es decir, la función descrita por
function_id.Este valor es igual a
event_processors.FUNCTION.function_name. Puede definirlo aquí o enevent_processors.FUNCTION.function_name. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
function_name, el backend lo duplica enevent_processors.FUNCTION.function_name.Si define
function_name,event_processorsno es obligatorio. Debe proporcionarfunction_nameoevent_processorsal actualizar un disparador. -
Un objeto donde cada nombre de campo es un ID de procesador de eventos y cada valor es un objeto que configura su procesador de eventos correspondiente. Para ver un ejemplo de objeto de configuración, consulte Enviar eventos de activación a AWS EventBridge.
Ocultar atributos de event_processors Mostrar atributos de event_processors Objeto
-
Ocultar atributo FUNCTION Mostrar atributo FUNCIÓN Objeto
-
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
-
El ID de la función que el disparador llama cuando se activa.
Este valor es el mismo que el
function_idde nivel raíz. Puede definirlo aquí o enfunction_id. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
event_processors.FUNCTION.function_id, el backend lo duplica enfunction_id.Si define
function_id,event_processorsno es obligatorio. Debe proporcionarfunction_idoevent_processorsal actualizar un disparador. -
El nombre de la función que el disparador llama cuando se activa, es decir, la función descrita por
function_id.Este valor es el mismo que el
function_namede nivel raíz. Puede definirlo aquí o enfunction_name. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
event_processors.FUNCTION.function_name, el backend lo duplica enfunction_name.Si define
function_name,event_processorsno es obligatorio. Debe proporcionarfunction_nameoevent_processorsal actualizar un disparador.
-
-
-
Ocultar el atributo AWS_EVENTBRIDGE Mostrar el atributo AWS_EVENTBRIDGE Objeto
-
-
Un objeto que define la gestión de errores personalizada para un disparador de AWS EventBridge. Válido solo para disparadores de tipo
"DATABASE"con procesadores de eventos"AWS_EVENTBRIDGE".Ocultar el atributo error_handler Mostrar el atributo error_handler Objeto
-
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
-
Ocultar atributos Mostrar atributos
-
Identificador único del disparador.
-
El nombre del activador.
-
El tipo de disparador. Para los disparadores de autenticación, este valor siempre es
"AUTHENTICATION".El valor es
AUTHENTICATION. -
Si es
true, el disparador está deshabilitado y no escucha eventos ni se ejecuta.El valor predeterminado es
false. -
Un objeto que define valores de configuración para el disparador.
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
-
El tipo de evento de autenticación que el disparador escucha.
Los valores son
LOGIN,CREATEoDELETE. -
El tipo(s) de proveedor de autenticación que escucha el disparador.
Los valores son
anon-user,api-key,custom-token,custom-function,local-userpass,oauth2-apple,oauth2-facebookooauth2-google.
-
-
El ID de la función que el disparador llama cuando se activa.
Este valor es igual a
event_processors.FUNCTION.function_id. Puede definirlo aquí o enevent_processors.FUNCTION.function_id. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
function_id, el backend lo duplica enevent_processors.FUNCTION.function_id.Si define
function_id,event_processorsno es obligatorio. Debe proporcionarfunction_idoevent_processorsal actualizar un disparador. -
El nombre de la función que el disparador llama cuando se activa, es decir, la función descrita por
function_id.Este valor es igual a
event_processors.FUNCTION.function_name. Puede definirlo aquí o enevent_processors.FUNCTION.function_name. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
function_name, el backend lo duplica enevent_processors.FUNCTION.function_name.Si define
function_name,event_processorsno es obligatorio. Debe proporcionarfunction_nameoevent_processorsal actualizar un disparador. -
Un objeto donde cada nombre de campo es un ID de procesador de eventos y cada valor es un objeto que configura su procesador de eventos correspondiente. Para ver un ejemplo de objeto de configuración, consulte Enviar eventos de activación a AWS EventBridge.
Ocultar atributos de event_processors Mostrar atributos de event_processors Objeto
-
Ocultar atributo FUNCTION Mostrar atributo FUNCIÓN Objeto
-
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
-
El ID de la función que el disparador llama cuando se activa.
Este valor es el mismo que el
function_idde nivel raíz. Puede definirlo aquí o enfunction_id. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
event_processors.FUNCTION.function_id, el backend lo duplica enfunction_id.Si define
function_id,event_processorsno es obligatorio. Debe proporcionarfunction_idoevent_processorsal actualizar un disparador. -
El nombre de la función que el disparador llama cuando se activa, es decir, la función descrita por
function_id.Este valor es el mismo que el
function_namede nivel raíz. Puede definirlo aquí o enfunction_name. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
event_processors.FUNCTION.function_name, el backend lo duplica enfunction_name.Si define
function_name,event_processorsno es obligatorio. Debe proporcionarfunction_nameoevent_processorsal actualizar un disparador.
-
-
-
Ocultar el atributo AWS_EVENTBRIDGE Mostrar el atributo AWS_EVENTBRIDGE Objeto
-
Ocultar atributos Mostrar atributos
-
Identificador único del disparador.
-
El nombre del activador.
-
El tipo de disparador. Para los disparadores programados, este valor siempre es
"SCHEDULED".El valor es
SCHEDULED. -
Si es
true, el disparador está deshabilitado y no escucha eventos ni se ejecuta.El valor predeterminado es
false. -
Un objeto que define valores de configuración para el disparador.
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
-
Una expresión cron que especifica cuándo se ejecuta el disparador.
-
Si es
true, habilitar el disparador después de haberlo deshabilitado no invocará eventos que ocurrieron mientras el disparador estaba deshabilitado.
-
-
El ID de la función que el disparador llama cuando se activa.
Este valor es igual a
event_processors.FUNCTION.function_id. Puede definirlo aquí o enevent_processors.FUNCTION.function_id. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
function_id, el backend lo duplica enevent_processors.FUNCTION.function_id.Si define
function_id,event_processorsno es obligatorio. Debe proporcionarfunction_idoevent_processorsal actualizar un disparador. -
El nombre de la función que el disparador llama cuando se activa, es decir, la función descrita por
function_id.Este valor es igual a
event_processors.FUNCTION.function_name. Puede definirlo aquí o enevent_processors.FUNCTION.function_name. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
function_name, el backend lo duplica enevent_processors.FUNCTION.function_name.Si define
function_name,event_processorsno es obligatorio. Debe proporcionarfunction_nameoevent_processorsal actualizar un disparador. -
Un objeto donde cada nombre de campo es un ID de procesador de eventos y cada valor es un objeto que configura su procesador de eventos correspondiente. Para ver un ejemplo de objeto de configuración, consulte Enviar eventos de activación a AWS EventBridge.
Ocultar atributos de event_processors Mostrar atributos de event_processors Objeto
-
Ocultar atributo FUNCTION Mostrar atributo FUNCIÓN Objeto
-
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
-
El ID de la función que el disparador llama cuando se activa.
Este valor es el mismo que el
function_idde nivel raíz. Puede definirlo aquí o enfunction_id. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
event_processors.FUNCTION.function_id, el backend lo duplica enfunction_id.Si define
function_id,event_processorsno es obligatorio. Debe proporcionarfunction_idoevent_processorsal actualizar un disparador. -
El nombre de la función que el disparador llama cuando se activa, es decir, la función descrita por
function_id.Este valor es el mismo que el
function_namede nivel raíz. Puede definirlo aquí o enfunction_name. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
event_processors.FUNCTION.function_name, el backend lo duplica enfunction_name.Si define
function_name,event_processorsno es obligatorio. Debe proporcionarfunction_nameoevent_processorsal actualizar un disparador.
-
-
-
Ocultar el atributo AWS_EVENTBRIDGE Mostrar el atributo AWS_EVENTBRIDGE Objeto
-
-
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
}