路径参数

• groupId 字符串 必需

  Atlas 项目/组 ID。

• appId 字符串 必需

  您的应用程序的 ObjectID。App Services API 项目和应用程序 ID 部分演示了如何查找此值。

• eventSubscriptionId 字符串 必需

  事件订阅的唯一 _id 值。

响应

• 200 application/json

  成功。

  对变更事件流的订阅。

  以下之一：

  对象-2 对象 对象-2 对象 对象-2 对象 SyncTranslator 对象

  隐藏属性 显示属性

  • _id 字符串

    触发器的唯一 ID。

  • 名称 字符串 必需

    触发器的名称。

  • 类型 字符串 必需

    触发类型。对于数据库触发器，该值始终为 "DATABASE"。

    值为 DATABASE。

  • 残疾人 布尔

    如果为 true，则禁用触发器，不监听事件，也不执行触发。

    默认值为false 。

  • config 对象 必需

    定义触发器配置值的对象。

    隐藏配置属性 显示配置属性 对象

    • service_id 字符串 必需

      包含监视集合的链接MongoDB数据源的 _id 值。

      您可以使用“获取所有服务”端点列出服务。

      数据源是 type 为“mongodb-atlas”的服务。使用要链接到触发的数据源的 _id 值。

    • database 字符串

      链接数据源中数据库的名称。如果省略此参数，源类型将更改为“部署”。但是，共享层级基础架构不支持部署变更流。如果省略“数据库 ”参数，则会收到“共享层级集群不支持部署变更流”错误。提供数据库参数以解决此错误。

    • 集合 字符串

      指定数据库中的集合名称。触发侦听该集合中的事件。 如果省略此参数，源类型将更改为“数据库”。

    • operation_types array[string] 必需

      触发侦听的MongoDB更改事件的类型。

      所有触发器的有效操作类型包括：

      • "INSERT"
      • "UPDATE"
      • "REPLACE"
      • "DELETE"

      数据库和部署触发器的其他有效操作类型包括：

      • "CREATE_COLLECTION"
      • "MODIFY_COLLECTION"
      • "RENAME_COLLECTION"
      • "DROP_COLLECTION"
      • "SHARD_COLLECTION"
      • "RESHARD_COLLECTION"
      • "REFINE_COLLECTION_SHARD_KEY"

      部署触发器的其他有效操作类型包括：

      • "DROP_DATABASE"

      有关详细信息，请参阅触发配置。

      至少 1 个元素。

    • 匹配 对象

      $match表达式筛选更改事件。仅当给定变更事件的表达式计算结果为 true 时，触发才会触发。

    • 项目 对象

      $ 项目 表达式仅返回指定的字段。您可以包含或排除特定字段，或包含新计算的字段。

    • full_document 布尔

      true如果为 ，则表示UPDATE 更改事件应在 fullDocument字段中包含已修改文档的最新多数提交版本。

      默认值为false 。

    • full_document_before_change 布尔

      如果为 true，则表示 UPDATE 更改事件应包含应用更新之前已修改文档的快照。

      您必须为集群启用文档原像才能包含这些快照。

      默认值为false 。

    • skip_catchup_events 布尔

      如果为 true，则在禁用触发器后启用触发将不会调用禁用触发时发生的事件。

      默认值为false 。

    • tolerate_resume_errors 布尔

      如果为 true，则当在集群的oplog中找不到此触发器的恢复令牌时，触发会在下一个相关变更流事件时自动恢复处理事件。 从触发暂停到触发恢复执行的所有变更流事件都不会触发触发。

      默认值为false 。

    • maximum_throughput 布尔

      如果为 true，则触发将使用最大化吞吐量选项。

      默认值为false 。

    • 无序 布尔

      如果为 true，则禁用事件排序，并且此触发可以进程事件。 如果为 false，则启用事件排序，并且触发按顺序执行事件。

      默认值为false 。

  • function_id 字符串

    触发器在触发时调用的函数的 ID。

    该值与 event_processors.FUNCTION.function_id 相同。您可以在此处或在 event_processors.FUNCTION.function_id 中定义该值。App Services 后端会将该值复制到您未定义该值的配置位置。

    例如，如果您定义了 function_id，后端会将其复制到 event_processors.FUNCTION.function_id。

    如果定义了 function_id，则不需要 event_processors。更新触发时，必须提供 function_id 或 event_processors。

  • function_name 字符串

    触发器触发时调用的函数名称，即 function_id 所描述的函数。

    该值与 event_processors.FUNCTION.function_name 相同。您可以在此处或在 event_processors.FUNCTION.function_name 中定义该值。App Services 后端会将该值复制到您未定义该值的配置位置。

    例如，如果您定义了 function_name，后端会将其复制到 event_processors.FUNCTION.function_name。

    如果定义了 function_name，则不需要 event_processors。更新触发时，必须提供 function_name 或 event_processors。

  • event_processors 对象 必需

    对象，其中每个字段名称都是事件处理器 ID，每个值都是配置相应事件处理器的对象。有关配置对象示例，请参阅“将触发事件发送到 AWS EventBridge”。

    隐藏 event_processors 属性 显示 event_processors 属性 对象

    • function 对象
      隐藏 FUNCTION 属性 显示 FUNCTION 属性 对象

      • config 对象
        隐藏配置属性 显示配置属性 对象

        • function_id 字符串

          触发器在触发时调用的函数的 ID。

          此值与根级 function_id 相同。您可以在此处或在 function_id 中定义该值。App Services后端会将该值复制到您未定义该值的配置位置。

          例如，如果您定义了 event_processors.FUNCTION.function_id，后端会将其复制到 function_id。

          如果定义了 function_id，则不需要 event_processors。更新触发时，必须提供 function_id 或 event_processors。

        • function_name 字符串

          触发器触发时调用的函数名称，即 function_id 所描述的函数。

          此值与根级 function_name 相同。您可以在此处或在 function_name 中定义该值。App Services后端会将该值复制到您未定义该值的配置位置。

          例如，如果您定义了 event_processors.FUNCTION.function_name，后端会将其复制到 function_name。

          如果定义了 function_name，则不需要 event_processors。更新触发时，必须提供 function_name 或 event_processors。

    • AWS_EVENTBRIDGE 对象
      隐藏 AWS_EVENTBRIDGE 属性 显示 AWS_EVENTBRIDGE 属性 对象

      • config 对象
        隐藏配置属性 显示配置属性 对象

        • account_id 字符串

          Amazon Web Services帐户ID。

        • 区域 字符串

          一个 Amazon Web Services 地区。

        • Extended_json_enabled 布尔

          如果为 true，则使用EJSON对事件对象进行序列化。

          默认值为false 。

  • error_handler 对象

    为 AWS EventBridge 触发器定义自定义错误处理的对象。 "DATABASE""AWS_EVENTBRIDGE"仅对具有事件处理器的Atlas Triggers类型有效。

    隐藏 error_handler 属性 显示 error_handler 属性 对象

    • config 对象
      隐藏配置属性 显示配置属性 对象

      • enabled 布尔

        如果为“true”，则为AWS Eventbridge触发启用自定义错误处理。

      • function_id 字符串

        当AWS Eventbridge触发失败且无法成功重试时调用的函数的ID 。

  隐藏属性 显示属性

  • _id 字符串

    触发器的唯一 ID。

  • 名称 字符串 必需

    触发器的名称。

  • 类型 字符串 必需

    触发类型。 对于身份验证触发器，此值始终为 "AUTHENTICATION"。

    值为 AUTHENTICATION。

  • 残疾人 布尔

    如果为 true，则禁用触发器，不监听事件，也不执行触发。

    默认值为false 。

  • config 对象 必需

    定义触发器配置值的对象。

    隐藏配置属性 显示配置属性 对象

    • operation_type 字符串 必需

      触发侦听的身份验证事件的类型。

      值为 LOGIN、CREATE 或 DELETE。

    • providers 字符串 必需

      触发侦听的身份验证提供者程序的类型。

      取值为 anon-user、api-key、custom-token、custom-function、local-userpass、oauth2-apple、oauth2-facebook 或 oauth2-google。

  • function_id 字符串

    触发器在触发时调用的函数的 ID。

    该值与 event_processors.FUNCTION.function_id 相同。您可以在此处或在 event_processors.FUNCTION.function_id 中定义该值。App Services 后端会将该值复制到您未定义该值的配置位置。

    例如，如果您定义了 function_id，后端会将其复制到 event_processors.FUNCTION.function_id。

    如果定义了 function_id，则不需要 event_processors。更新触发时，必须提供 function_id 或 event_processors。

  • function_name 字符串

    触发器触发时调用的函数名称，即 function_id 所描述的函数。

    该值与 event_processors.FUNCTION.function_name 相同。您可以在此处或在 event_processors.FUNCTION.function_name 中定义该值。App Services 后端会将该值复制到您未定义该值的配置位置。

    例如，如果您定义了 function_name，后端会将其复制到 event_processors.FUNCTION.function_name。

    如果定义了 function_name，则不需要 event_processors。更新触发时，必须提供 function_name 或 event_processors。

  • event_processors 对象 必需

    对象，其中每个字段名称都是事件处理器 ID，每个值都是配置相应事件处理器的对象。有关配置对象示例，请参阅“将触发事件发送到 AWS EventBridge”。

    隐藏 event_processors 属性 显示 event_processors 属性 对象

    • function 对象
      隐藏 FUNCTION 属性 显示 FUNCTION 属性 对象

      • config 对象
        隐藏配置属性 显示配置属性 对象

        • function_id 字符串

          触发器在触发时调用的函数的 ID。

          此值与根级 function_id 相同。您可以在此处或在 function_id 中定义该值。App Services后端会将该值复制到您未定义该值的配置位置。

          例如，如果您定义了 event_processors.FUNCTION.function_id，后端会将其复制到 function_id。

          如果定义了 function_id，则不需要 event_processors。更新触发时，必须提供 function_id 或 event_processors。

        • function_name 字符串

          触发器触发时调用的函数名称，即 function_id 所描述的函数。

          此值与根级 function_name 相同。您可以在此处或在 function_name 中定义该值。App Services后端会将该值复制到您未定义该值的配置位置。

          例如，如果您定义了 event_processors.FUNCTION.function_name，后端会将其复制到 function_name。

          如果定义了 function_name，则不需要 event_processors。更新触发时，必须提供 function_name 或 event_processors。

    • AWS_EVENTBRIDGE 对象
      隐藏 AWS_EVENTBRIDGE 属性 显示 AWS_EVENTBRIDGE 属性 对象

      • config 对象
        隐藏配置属性 显示配置属性 对象

        • account_id 字符串

          Amazon Web Services帐户ID。

        • 区域 字符串

          一个 Amazon Web Services 地区。

        • Extended_json_enabled 布尔

          如果为 true，则使用EJSON对事件对象进行序列化。

          默认值为false 。

  隐藏属性 显示属性

  • _id 字符串

    触发器的唯一 ID。

  • 名称 字符串 必需

    触发器的名称。

  • 类型 字符串 必需

    触发类型。 对于定时触发器，此值始终为 "SCHEDULED"。

    值为 SCHEDULED。

  • 残疾人 布尔

    如果为 true，则禁用触发器，不监听事件，也不执行触发。

    默认值为false 。

  • config 对象 必需

    定义触发器配置值的对象。

    隐藏配置属性 显示配置属性 对象

    • 进度表 字符串 必需

      一个cron表达式，用于指定触发何时执行。

    • skip_catchup_events 布尔

      如果为 true，则在禁用触发器后启用触发将不会调用禁用触发时发生的事件。

  • function_id 字符串

    触发器在触发时调用的函数的 ID。

    该值与 event_processors.FUNCTION.function_id 相同。您可以在此处或在 event_processors.FUNCTION.function_id 中定义该值。App Services 后端会将该值复制到您未定义该值的配置位置。

    例如，如果您定义了 function_id，后端会将其复制到 event_processors.FUNCTION.function_id。

    如果定义了 function_id，则不需要 event_processors。更新触发时，必须提供 function_id 或 event_processors。

  • function_name 字符串

    触发器触发时调用的函数名称，即 function_id 所描述的函数。

    该值与 event_processors.FUNCTION.function_name 相同。您可以在此处或在 event_processors.FUNCTION.function_name 中定义该值。App Services 后端会将该值复制到您未定义该值的配置位置。

    例如，如果您定义了 function_name，后端会将其复制到 event_processors.FUNCTION.function_name。

    如果定义了 function_name，则不需要 event_processors。更新触发时，必须提供 function_name 或 event_processors。

  • event_processors 对象 必需

    对象，其中每个字段名称都是事件处理器 ID，每个值都是配置相应事件处理器的对象。有关配置对象示例，请参阅“将触发事件发送到 AWS EventBridge”。

    隐藏 event_processors 属性 显示 event_processors 属性 对象

    • function 对象
      隐藏 FUNCTION 属性 显示 FUNCTION 属性 对象

      • config 对象
        隐藏配置属性 显示配置属性 对象

        • function_id 字符串

          触发器在触发时调用的函数的 ID。

          此值与根级 function_id 相同。您可以在此处或在 function_id 中定义该值。App Services后端会将该值复制到您未定义该值的配置位置。

          例如，如果您定义了 event_processors.FUNCTION.function_id，后端会将其复制到 function_id。

          如果定义了 function_id，则不需要 event_processors。更新触发时，必须提供 function_id 或 event_processors。

        • function_name 字符串

          触发器触发时调用的函数名称，即 function_id 所描述的函数。

          此值与根级 function_name 相同。您可以在此处或在 function_name 中定义该值。App Services后端会将该值复制到您未定义该值的配置位置。

          例如，如果您定义了 event_processors.FUNCTION.function_name，后端会将其复制到 function_name。

          如果定义了 function_name，则不需要 event_processors。更新触发时，必须提供 function_name 或 event_processors。

    • AWS_EVENTBRIDGE 对象
      隐藏 AWS_EVENTBRIDGE 属性 显示 AWS_EVENTBRIDGE 属性 对象

      • config 对象
        隐藏配置属性 显示配置属性 对象

        • account_id 字符串

          Amazon Web Services帐户ID。

        • 区域 字符串

          一个 Amazon Web Services 地区。

        • Extended_json_enabled 布尔

          如果为 true，则使用EJSON对事件对象进行序列化。

          默认值为false 。

  隐藏属性 显示属性

  • _id 字符串
  • 名称 字符串
  • 类型 字符串

    值为 SYNCTRANSLATOR。

  • function_id 字符串
  • 残疾人 布尔
  • config null
  • last_modified 数字