Actualizar un disparador

PUT /groups/{groupId}/aplicacións/{appId}/activars/{triggerId}

Autorización de token

Modificar un disparador existente en su aplicación.

Parámetros de ruta

ID de grupo string Requerido

Un ID de proyecto/grupo Atlas.
ID de aplicación string Requerido

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.
ID de disparador string Requerido

El valor único _id de un disparador.

aplicación/json

Cuerpo Objeto Requerido

La configuración del disparador actualizada.

_id string

Identificador único del disparador.
Nombre string Requerido

El nombre del activador.
tipo string Requerido

El tipo de disparador. Para los disparadores de base de datos, este valor siempre es "DATABASE".

El valor es DATABASE.
inhabilitado booleano

Si es true, el disparador está deshabilitado y no escucha eventos ni se ejecuta.

El valor predeterminado es false.
config Objeto Requerido

Un objeto que define valores de configuración para el disparador.
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
- id_de_servicio string Requerido
  
  El valor _id de 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 type es "mongodb-atlas". Use el valor _id para la fuente de datos que desea vincular al disparador.
- database string
  
  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.
- Colección string
  
  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".
- tipos_de_operación array[string] Requerido
  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 1 elemento.
- coincidencia Objeto
  
  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.
- Proyecto Objeto
  
  Una expresión $project devuelve solo los campos especificados. Puede incluir o excluir campos específicos, o incluir campos recién calculados.
- full_document booleano
  
  Si true es, indica que UPDATE eventos de cambio deben incluir la versión más actual y mayoritariamente comprometida del documento modificado en el fullDocument campo.
  
  El valor predeterminado es false.
- documento completo antes del cambio booleano
  
  Si es verdadero, indica que UPDATE eventos 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.
- saltar_eventos_de_recuperación booleano
  
  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.
- tolerate_resume_errors booleano
  
  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.
- valor máximo de transferencia booleano
  
  Si true es, el disparador utilizará la opción de maximizar el rendimiento.
  
  El valor predeterminado es false.
- desordenado booleano
  
  Si es true, la ordenación de eventos está deshabilitada y este disparador puede procesar eventos en paralelo. Si es false, la ordenación de eventos está habilitada y el disparador ejecuta eventos en serie.
  
  El valor predeterminado es false.
id_de_función string

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 en event_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 en event_processors.FUNCTION.function_id.

Si define function_id, event_processors no es obligatorio. Debe proporcionar function_id o event_processors al actualizar un disparador.
nombre_de_función string

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 en event_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 en event_processors.FUNCTION.function_name.

Si define function_name, event_processors no es obligatorio. Debe proporcionar function_name o event_processors al actualizar un disparador.
event_processors Objeto Requerido

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
- FUNCIÓN Objeto
  Ocultar atributo FUNCTION Mostrar atributo FUNCIÓN Objeto
  
  config Objeto
  
  Ocultar atributos de configuración Mostrar atributos de configuración Objeto
  
  id_de_función string
  
  El ID de la función que el disparador llama cuando se activa.
  
  Este valor es el mismo que el function_id de nivel raíz. Puede definirlo aquí o en 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 event_processors.FUNCTION.function_id, el backend lo duplica en function_id.
  
  Si define function_id, event_processors no es obligatorio. Debe proporcionar function_id o event_processors al actualizar un disparador.
  
  nombre_de_función string
  
  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_name de nivel raíz. Puede definirlo aquí o en 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 event_processors.FUNCTION.function_name, el backend lo duplica en function_name.
  
  Si define function_name, event_processors no es obligatorio. Debe proporcionar function_name o event_processors al actualizar un disparador.
- Puente de eventos de AWS Objeto
  Ocultar el atributo AWS_EVENTBRIDGE Mostrar el atributo AWS_EVENTBRIDGE Objeto
  
  config Objeto
  
  Ocultar atributos de configuración Mostrar atributos de configuración Objeto
  
  ID de cuenta string
  
  Un ID de cuenta de AWS.
  
  región string
  
  Una región de AWS.
  
  extended_json_enabled booleano
  
  Si es true, los objetos de evento se serializan utilizando EJSON.
  
  El valor predeterminado es false.
error_handler 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
- config Objeto
  Ocultar atributos de configuración Mostrar atributos de configuración Objeto
  
  habilitado booleano
  
  Si es "verdadero", se habilita el manejo de errores personalizado para el activador de AWS EventBridge.
  
  id_de_función string
  
  El ID de la función invocada cuando el disparador de AWS EventBridge falla y no se puede volver a intentar correctamente.

_id string

Identificador único del disparador.
Nombre string Requerido

El nombre del activador.
tipo string Requerido

El tipo de disparador. Para los disparadores de autenticación, este valor siempre es "AUTHENTICATION".

El valor es AUTHENTICATION.
inhabilitado booleano

Si es true, el disparador está deshabilitado y no escucha eventos ni se ejecuta.

El valor predeterminado es false.
config Objeto Requerido

Un objeto que define valores de configuración para el disparador.
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
- tipo_de_operación string Requerido
  
  El tipo de evento de autenticación que el disparador escucha.
  
  Los valores son LOGIN, CREATE o DELETE.
- proveedores string Requerido
  
  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-facebook o oauth2-google.
id_de_función string

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 en event_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 en event_processors.FUNCTION.function_id.

Si define function_id, event_processors no es obligatorio. Debe proporcionar function_id o event_processors al actualizar un disparador.
nombre_de_función string

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 en event_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 en event_processors.FUNCTION.function_name.

Si define function_name, event_processors no es obligatorio. Debe proporcionar function_name o event_processors al actualizar un disparador.
event_processors Objeto Requerido

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
- FUNCIÓN Objeto
  Ocultar atributo FUNCTION Mostrar atributo FUNCIÓN Objeto
  
  config Objeto
  
  Ocultar atributos de configuración Mostrar atributos de configuración Objeto
  
  id_de_función string
  
  El ID de la función que el disparador llama cuando se activa.
  
  Este valor es el mismo que el function_id de nivel raíz. Puede definirlo aquí o en 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 event_processors.FUNCTION.function_id, el backend lo duplica en function_id.
  
  Si define function_id, event_processors no es obligatorio. Debe proporcionar function_id o event_processors al actualizar un disparador.
  
  nombre_de_función string
  
  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_name de nivel raíz. Puede definirlo aquí o en 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 event_processors.FUNCTION.function_name, el backend lo duplica en function_name.
  
  Si define function_name, event_processors no es obligatorio. Debe proporcionar function_name o event_processors al actualizar un disparador.
- Puente de eventos de AWS Objeto
  Ocultar el atributo AWS_EVENTBRIDGE Mostrar el atributo AWS_EVENTBRIDGE Objeto
  
  config Objeto
  
  Ocultar atributos de configuración Mostrar atributos de configuración Objeto
  
  ID de cuenta string
  
  Un ID de cuenta de AWS.
  
  región string
  
  Una región de AWS.
  
  extended_json_enabled booleano
  
  Si es true, los objetos de evento se serializan utilizando EJSON.
  
  El valor predeterminado es false.

_id string

Identificador único del disparador.
Nombre string Requerido

El nombre del activador.
tipo string Requerido

El tipo de disparador. Para los disparadores programados, este valor siempre es "SCHEDULED".

El valor es SCHEDULED.
inhabilitado booleano

Si es true, el disparador está deshabilitado y no escucha eventos ni se ejecuta.

El valor predeterminado es false.
config Objeto Requerido

Un objeto que define valores de configuración para el disparador.
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
- horario string Requerido
  
  Una expresión cron que especifica cuándo se ejecuta el disparador.
- saltar_eventos_de_recuperación booleano
  
  Si es true, habilitar el disparador después de haberlo deshabilitado no invocará eventos que ocurrieron mientras el disparador estaba deshabilitado.
id_de_función string

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 en event_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 en event_processors.FUNCTION.function_id.

Si define function_id, event_processors no es obligatorio. Debe proporcionar function_id o event_processors al actualizar un disparador.
nombre_de_función string

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 en event_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 en event_processors.FUNCTION.function_name.

Si define function_name, event_processors no es obligatorio. Debe proporcionar function_name o event_processors al actualizar un disparador.
event_processors Objeto Requerido

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
- FUNCIÓN Objeto
  Ocultar atributo FUNCTION Mostrar atributo FUNCIÓN Objeto
  
  config Objeto
  
  Ocultar atributos de configuración Mostrar atributos de configuración Objeto
  
  id_de_función string
  
  El ID de la función que el disparador llama cuando se activa.
  
  Este valor es el mismo que el function_id de nivel raíz. Puede definirlo aquí o en 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 event_processors.FUNCTION.function_id, el backend lo duplica en function_id.
  
  Si define function_id, event_processors no es obligatorio. Debe proporcionar function_id o event_processors al actualizar un disparador.
  
  nombre_de_función string
  
  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_name de nivel raíz. Puede definirlo aquí o en 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 event_processors.FUNCTION.function_name, el backend lo duplica en function_name.
  
  Si define function_name, event_processors no es obligatorio. Debe proporcionar function_name o event_processors al actualizar un disparador.
- Puente de eventos de AWS Objeto
  Ocultar el atributo AWS_EVENTBRIDGE Mostrar el atributo AWS_EVENTBRIDGE Objeto
  
  config Objeto
  
  Ocultar atributos de configuración Mostrar atributos de configuración Objeto
  
  ID de cuenta string
  
  Un ID de cuenta de AWS.
  
  región string
  
  Una región de AWS.
  
  extended_json_enabled booleano
  
  Si es true, los objetos de evento se serializan utilizando EJSON.
  
  El valor predeterminado es false.

Respuestas

204

Se actualizó exitosamente el disparador.
409 aplicación/json

Se encontró un error al actualizar el disparador.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Error string
  
  Un mensaje que describe el error.
- error_code string
  
  El tipo de error.

PONER /grupos/{groupId}/aplicaciones/{appId}/activadores/{triggerId}

curl \
 --request PUT 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/triggers/{triggerId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"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"}}}}'

Solicitar ejemplos

{
  "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"
      }
    }
  }
}

Ejemplos de respuestas (409)

{
  "error": "string",
  "error_code": "string"
}