イベントサブスクリプションを一覧表示する

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

tokenAuth

すべてのイベントサブスクリプションを取得します。

path パラメータ

グループ ID string 必須

Atlas Project/Group ID。
appId string 必須

アプリケーションの ObjectID。App Services API プロジェクトとアプリケーション ID のセクションでは、この値を見つける方法が示されています。

クエリパラメータ

タイプ string
返すイベントサブスクリプションの種類。
- DATABASE: データベース Triggers を返す
- AUTHENTICATION: 認証 Triggers を返す
- SCHEDULED: 予定された Triggers を返す
- SYNCTRANSLATOR: Device Sync トランスレーターを返す
値は、DATABASE、AUTHENTICATION、SCHEDULED、または SYNCTRANSLATOR です。

応答

200 application/ JSON

操作に成功しました。
変更イベントストリームへのサブスクライブ。
次の 1 つ：
オブジェクト-2 オブジェクトオブジェクト-2 オブジェクトオブジェクト-2 オブジェクト SyncTranslator オブジェクト
属性を非表示属性を表示

_id string

trigger のユニークな ID。

name string 必須

trigger 名。

タイプ string 必須

Triggers の種類。データベース Triggers の場合、この値は常に "DATABASE" になります。

値は DATABASE です。

disabled ブール値

trueの場合、trigger は無効になり、イベントをリスニングしたり実行したりしません。

デフォルト値はfalseです。

config オブジェクト必須

trigger の構成値を定義するオブジェクト。

設定属性を非表示にするコンフィギュレーション属性を表示オブジェクト

service_id string 必須

監視対象のコレクションを含むリンクされたMongoDBデータソースの _id 値。

すべてのサービスを取得するエンドポイントを使用してサービスを一覧表示できます。

データソースは、type が「mongodb-atlas」であるサービスです。 trigger にリンクするデータソースには _id 値を使用します。

database string

リンクされたデータソース内のデータベースの名前。このパラメーターを省略すると、ソースタイプは "Deployment" に変わります。ただし、共有階層インフラストラクチャは配置の変更ストリームをサポートしていません。「データベース」パラメーターを省略すると、「配置の変更ストリームは共有層クラスターではサポートされていません」というエラーが返されます。このエラーを解決するには、データベースパラメータを指定します。

コレクション string

指定したデータベース内のコレクションの名前。trigger は、このコレクションのイベントをリッスンします。このパラメーターを省略すると、ソースタイプは「データベース」に変わります。

operation_types array[string] 必須

trigger がリッスンするMongoDB変更イベントのタイプ。

すべての trigger で有効な操作タイプは次のとおりです。

"INSERT"

"UPDATE"

"REPLACE"

"DELETE"

データベースと配置トリガーには、次の有効な操作タイプがあります。

"CREATE_COLLECTION"

"MODIFY_COLLECTION"

"RENAME_COLLECTION"

"DROP_COLLECTION"

"SHARD_COLLECTION"

"RESHARD_COLLECTION"

"REFINE_COLLECTION_SHARD_KEY"

配置 trigger の追加の有効な操作タイプは、次のとおりです。

"DROP_DATABASE"

詳細については、trigger 構成を参照してください。

少なくとも 1 要素。

一致オブジェクト

$match式は変更イベントをフィルタリングします。trigger は、特定の変更イベントに対して式が true と評価された場合にのみ起動します。

プロジェクトオブジェクト

$プロジェクト式は、指定されたフィールドのみを返します。特定のフィールドを含めたり除外したり、新しく計算されたフィールドを含めたりすることができます。

full_document ブール値

true の場合、UPDATE 変更イベントには、修正されたドキュメントの最新の過半数がコミットしたバージョンを fullDocumentフィールドに含める必要があることを示します。

デフォルト値はfalseです。

full_document_Before_change ブール値

true の場合、は UPDATE 変更イベントに更新が適用される直前の変更されたドキュメントのスナップショットを含める必要があることを示します。

これらのスナップショットを含めるには、クラスターでドキュメントプレイメージを有効にする必要があります。

デフォルト値はfalseです。

skip_atchup_events ブール値

true の場合、trigger を無効にした後に trigger を有効にしても、trigger が無効になっている間に発生したイベントは呼び出されません。

デフォルト値はfalseです。

tolerate_resume_errors ブール値

true の場合、この trigger の再開トークンがクラスターのoplogに見つからない場合、trigger は次の関連する変更ストリームイベントでイベントの情報処理を自動的に再開します。trigger が一時停止されてから trigger が実行を再開するまでのすべての変更ストリームイベントでは、trigger は起動しません。

デフォルト値はfalseです。

maximum_際スループットブール値

true の場合、trigger は最大スループットオプションを使用します。

デフォルト値はfalseです。

順序付けなしブール値

true の場合、イベント順序は無効になり、この trigger はイベントを並列に処理できます。false の場合、イベントの順序付けが有効になり、trigger はイベントを連続して実行します。

デフォルト値はfalseです。

function_id string

trigger が起動時に呼び出す関数の ID。

この値は event_processors.FUNCTION.function_id と同じです。ここで値を定義することも、event_processors.FUNCTION.function_id で値を定義することもできます。App Services バックエンドは、値が定義されていない構成の場所に値を複製します。

たとえば、 function_id を定義すると、バックエンドはそれを event_processors.FUNCTION.function_id に複製します。

function_id を定義する場合、event_processors は必要ありません。trigger を更新するときは、function_id または event_processors のいずれかを指定する必要があります。

function_name string

trigger が起動したときに呼び出す関数の名前、つまり 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 は必要ありません。trigger を更新するときは、function_name または event_processors のいずれかを指定する必要があります。

event_processors オブジェクト必須

App Services バックエンドは、値が定義されていない構成の場所に値を複製します。設定オブジェクトの例については、「AWS EventBridge へのトリガーイベントの送信」を参照してください。

event_processors 属性を非表示にする event_processors 属性の表示オブジェクト

関数オブジェクト

FUNCTION 属性を非表示 FUNCTION 属性の表示オブジェクト

config オブジェクト

設定属性を非表示にするコンフィギュレーション属性を表示オブジェクト

function_id string

trigger が起動時に呼び出す関数の ID。

この値はルートレベルの function_id と同じです。ここで値を定義することも、function_id で値を定義することもできます。App Servicesバックエンドは、値が定義されていない構成の場所に値を複製します。

たとえば、 event_processors.FUNCTION.function_id を定義すると、バックエンドはそれを function_id に複製します。

function_id を定義する場合、event_processors は必要ありません。trigger を更新するときは、function_id または event_processors のいずれかを指定する必要があります。

function_name string

trigger が起動したときに呼び出す関数の名前、つまり function_id で記述される関数。

この値はルートレベルの function_name と同じです。ここで値を定義することも、function_name で値を定義することもできます。App Servicesバックエンドは、値が定義されていない構成の場所に値を複製します。

たとえば、 event_processors.FUNCTION.function_name を定義すると、バックエンドはそれを function_name に複製します。

function_name を定義する場合、event_processors は必要ありません。trigger を更新するときは、function_name または event_processors のいずれかを指定する必要があります。

AWS_eventbridge オブジェクト

AWS_EventbrIDGE 属性を非表示にする AWS_EventbrIDGE 属性を表示オブジェクト

config オブジェクト

設定属性を非表示にするコンフィギュレーション属性を表示オブジェクト

count_id string

Amazon Web ServicesアカウントID。

リージョン string

Amazon Web Servicesのリージョン。

Extended_json_enabled ブール値

true の場合、イベントオブジェクトは EJSON を使用して直列化されます。

デフォルト値はfalseです。

error_handler オブジェクト

AWS EventBridge Triggers のカスタムエラー処理を定義するオブジェクト。"AWS_EVENTBRIDGE"イベントプロセッサーを持つ"DATABASE" 型の Triggers に対してのみ有効です。

errors_handler 属性を非表示 errors_handler 属性を表示オブジェクト

config オブジェクト

設定属性を非表示にするコンフィギュレーション属性を表示オブジェクト

enabled ブール値

「true」の場合、 AWS Eventbridge Trigger でカスタムエラー処理が有効になります。

function_id string

AWS Eventbridge trigger が失敗し、正常に再試行できない場合に呼び出される関数のID 。
属性を非表示属性を表示

_id string

trigger のユニークな ID。

name string 必須

trigger 名。

タイプ string 必須

trigger の種類。認証trigger の場合、この値は常に "AUTHENTICATION" になります。

値は AUTHENTICATION です。

disabled ブール値

trueの場合、trigger は無効になり、イベントをリスニングしたり実行したりしません。

デフォルト値はfalseです。

config オブジェクト必須

trigger の構成値を定義するオブジェクト。

設定属性を非表示にするコンフィギュレーション属性を表示オブジェクト

operation_type string 必須

trigger が listen する認証イベントのタイプ。

値は LOGIN、CREATE、または DELETE です。

providers string 必須

trigger が listen する認証プロバイダのタイプ。

値は、anon-user、api-key、custom-token、custom-function、local-userpass、oauth2-apple、oauth2-facebook、または oauth2-google です。

function_id string

trigger が起動時に呼び出す関数の ID。

この値は event_processors.FUNCTION.function_id と同じです。ここで値を定義することも、event_processors.FUNCTION.function_id で値を定義することもできます。App Services バックエンドは、値が定義されていない構成の場所に値を複製します。

たとえば、 function_id を定義すると、バックエンドはそれを event_processors.FUNCTION.function_id に複製します。

function_id を定義する場合、event_processors は必要ありません。trigger を更新するときは、function_id または event_processors のいずれかを指定する必要があります。

function_name string

trigger が起動したときに呼び出す関数の名前、つまり 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 は必要ありません。trigger を更新するときは、function_name または event_processors のいずれかを指定する必要があります。

event_processors オブジェクト必須

App Services バックエンドは、値が定義されていない構成の場所に値を複製します。設定オブジェクトの例については、「AWS EventBridge へのトリガーイベントの送信」を参照してください。

event_processors 属性を非表示にする event_processors 属性の表示オブジェクト

関数オブジェクト

FUNCTION 属性を非表示 FUNCTION 属性の表示オブジェクト

config オブジェクト

設定属性を非表示にするコンフィギュレーション属性を表示オブジェクト

function_id string

trigger が起動時に呼び出す関数の ID。

この値はルートレベルの function_id と同じです。ここで値を定義することも、function_id で値を定義することもできます。App Servicesバックエンドは、値が定義されていない構成の場所に値を複製します。

たとえば、 event_processors.FUNCTION.function_id を定義すると、バックエンドはそれを function_id に複製します。

function_id を定義する場合、event_processors は必要ありません。trigger を更新するときは、function_id または event_processors のいずれかを指定する必要があります。

function_name string

trigger が起動したときに呼び出す関数の名前、つまり function_id で記述される関数。

この値はルートレベルの function_name と同じです。ここで値を定義することも、function_name で値を定義することもできます。App Servicesバックエンドは、値が定義されていない構成の場所に値を複製します。

たとえば、 event_processors.FUNCTION.function_name を定義すると、バックエンドはそれを function_name に複製します。

function_name を定義する場合、event_processors は必要ありません。trigger を更新するときは、function_name または event_processors のいずれかを指定する必要があります。

AWS_eventbridge オブジェクト

AWS_EventbrIDGE 属性を非表示にする AWS_EventbrIDGE 属性を表示オブジェクト

config オブジェクト

設定属性を非表示にするコンフィギュレーション属性を表示オブジェクト

count_id string

Amazon Web ServicesアカウントID。

リージョン string

Amazon Web Servicesのリージョン。

Extended_json_enabled ブール値

true の場合、イベントオブジェクトは EJSON を使用して直列化されます。

デフォルト値はfalseです。
属性を非表示属性を表示

_id string

trigger のユニークな ID。

name string 必須

trigger 名。

タイプ string 必須

trigger の種類。スケジュールされた trigger の場合、この値は常に "SCHEDULED" になります。

値は SCHEDULED です。

disabled ブール値

trueの場合、trigger は無効になり、イベントをリスニングしたり実行したりしません。

デフォルト値はfalseです。

config オブジェクト必須

trigger の構成値を定義するオブジェクト。

設定属性を非表示にするコンフィギュレーション属性を表示オブジェクト

schedule string 必須

trigger が実行されるタイミングを指定する cron式。

skip_atchup_events ブール値

true の場合、trigger を無効にした後に有効にしても、trigger が無効になっている間に発生したイベントは呼び出されません。

function_id string

trigger が起動時に呼び出す関数の ID。

この値は event_processors.FUNCTION.function_id と同じです。ここで値を定義することも、event_processors.FUNCTION.function_id で値を定義することもできます。App Services バックエンドは、値が定義されていない構成の場所に値を複製します。

たとえば、 function_id を定義すると、バックエンドはそれを event_processors.FUNCTION.function_id に複製します。

function_id を定義する場合、event_processors は必要ありません。trigger を更新するときは、function_id または event_processors のいずれかを指定する必要があります。

function_name string

trigger が起動したときに呼び出す関数の名前、つまり 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 は必要ありません。trigger を更新するときは、function_name または event_processors のいずれかを指定する必要があります。

event_processors オブジェクト必須

App Services バックエンドは、値が定義されていない構成の場所に値を複製します。設定オブジェクトの例については、「AWS EventBridge へのトリガーイベントの送信」を参照してください。

event_processors 属性を非表示にする event_processors 属性の表示オブジェクト

関数オブジェクト

FUNCTION 属性を非表示 FUNCTION 属性の表示オブジェクト

config オブジェクト

設定属性を非表示にするコンフィギュレーション属性を表示オブジェクト

function_id string

trigger が起動時に呼び出す関数の ID。

この値はルートレベルの function_id と同じです。ここで値を定義することも、function_id で値を定義することもできます。App Servicesバックエンドは、値が定義されていない構成の場所に値を複製します。

たとえば、 event_processors.FUNCTION.function_id を定義すると、バックエンドはそれを function_id に複製します。

function_id を定義する場合、event_processors は必要ありません。trigger を更新するときは、function_id または event_processors のいずれかを指定する必要があります。

function_name string

trigger が起動したときに呼び出す関数の名前、つまり function_id で記述される関数。

この値はルートレベルの function_name と同じです。ここで値を定義することも、function_name で値を定義することもできます。App Servicesバックエンドは、値が定義されていない構成の場所に値を複製します。

たとえば、 event_processors.FUNCTION.function_name を定義すると、バックエンドはそれを function_name に複製します。

function_name を定義する場合、event_processors は必要ありません。trigger を更新するときは、function_name または event_processors のいずれかを指定する必要があります。

AWS_eventbridge オブジェクト

AWS_EventbrIDGE 属性を非表示にする AWS_EventbrIDGE 属性を表示オブジェクト

config オブジェクト

設定属性を非表示にするコンフィギュレーション属性を表示オブジェクト

count_id string

Amazon Web ServicesアカウントID。

リージョン string

Amazon Web Servicesのリージョン。

Extended_json_enabled ブール値

true の場合、イベントオブジェクトは EJSON を使用して直列化されます。

デフォルト値はfalseです。
属性を非表示属性を表示

_id string

name string

タイプ string

値は SYNCTRANSLATOR です。

function_id string

disabled ブール値

config null

last_modified 数値

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

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

応答の例（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"
        }
      }
    }
  }
]

イベント サブスクリプションを一覧表示する

path パラメータ

クエリ パラメータ

応答

イベントサブスクリプションを一覧表示する

クエリパラメータ