現在のアプリ構成をダウンロードします。次の 2 種類から形式を選択して、ダウンロードできます。
構成ファイルのディレクトリを含む圧縮済み zip ファイル。CLI、バージョン管理システム、別のファイル システムのいずれかを基盤とする環境で作業している場合に最も便利です。
構成全体を含む単一のの JSON オブジェクト。APIを操作している場合や、JSON の解析が可能な別の環境で作業している場合に最も便利です。
ダウンロード時にファイル形式を指定するには、Accept ヘッダーを設定します。
path パラメータ
-
Atlas Project/Group ID。
-
アプリケーションの ObjectID。App Services API プロジェクトとアプリケーション ID のセクションでは、この値を見つける方法が示されています。
応答
-
プル成功
応答属性の非表示 応答属性の表示 オブジェクト
-
アプリ名。
provider_region
string 必須 次の 1 つ： 値は、
aws-us-east-1、aws-us-west-2、aws-us-east-2、aws-eu-central-1、aws-eu-west-1、aws-eu-west-2、aws-ap-southeast-1、aws-ap-southeast-2、aws-ap-south-1、またはaws-sa-east-1です。値は、
azure-eastus2、azure-westus、azure-westeurope、azure-eastasia、またはazure-southeastasiaです。値は、
gcp-us-central1、gcp-us-east4、gcp-us-west1、gcp-europe-west1、またはgcp-asia-south1です。-
アプリケーションの配置モデル。
値は
GLOBALまたはLOCALです。 -
アプリの環境タグ。指定されていない場合、アプリに環境タグはありません。
値は、
development、testing、qa、またはproductionです。 -
次のいずれか: 属性を非表示 属性を表示
-
認証プロバイダの名前。メール / パスワード認証の場合、この値は常に
local-userpassです。値は
local-userpassです。 -
認証プロバイダの名前。メール / パスワード認証の場合、この値は常に
local-userpassです。値は
local-userpassです。 -
trueの場合、認証プロバイダーは無効化されます。プロバイダーが有効化されるまで、ユーザーはプロバイダー経由でログインできません。 config
オブジェクト 次の 1 つ： 属性を非表示 属性を表示
-
trueの場合、追加の検証なしで新しいユーザーアカウントを自動的に確認します。値は
trueです。 -
組み込みパスワード リセット フローの一部としてユーザーに送信されるメールに含まれるURL 。このメールには、クエリ パラメータとして一意のパスワード リセット
tokenとtokenIdも追加されます。このURL は、パスワード リセット トークンをRealm SDK の
resetPassword関数に渡してユーザー確認を処理します。 -
組み込みパスワード リセット フローの一部としてユーザーに送信されるメールの件名。
属性を非表示 属性を表示
-
trueの場合、追加の検証なしで新しいユーザーアカウントを自動的に確認します。組み込みメールアカウント確認については、この値をfalseに設定します。値は
falseです。 -
組み込み確認フローの一部として新しいユーザーに送信されるメールに含まれるURL 。このメールには、クエリ パラメータとして一意の確認
tokenとtokenIdも追加されます。このURL は、確認トークンをRealm SDK の
confirmUser関数または Admin API Confirm（保留中のメール/パスワード ユーザー）エンドポイントに渡してユーザー確認を処理します。 -
組み込み確認フローの一部として新しいユーザーに送信されるメールの件名。
-
組み込みパスワード リセット フローの一部としてユーザーに送信されるメールに含まれるURL 。このメールには、クエリ パラメータとして一意のパスワード リセット
tokenとtokenIdも追加されます。このURL は、パスワード リセット トークンをRealm SDK の
resetPassword関数に渡してユーザー確認を処理します。 -
組み込みパスワード リセット フローの一部としてユーザーに送信されるメールの件名。
属性を非表示 属性を表示
-
trueの場合、追加の検証なしで新しいユーザーアカウントを自動的に確認します。組み込みメールアカウント確認については、この値をfalseに設定します。値は
falseです。 -
組み込み確認フローの一部として新しいユーザーに送信されるメールに含まれるURL 。このメールには、クエリ パラメータとして一意の確認
tokenとtokenIdも追加されます。このURL は、確認トークンをRealm SDK の
confirmUser関数または Admin API Confirm（保留中のメール/パスワード ユーザー）エンドポイントに渡してユーザー確認を処理します。 -
組み込み確認フローの一部として新しいユーザーに送信されるメールの件名。
-
trueの場合は、定義したカスタム関数を使用してパスワード リセット プロセスを処理します。値は
trueです。 -
パスワードのリセット プロセスを取り扱うカスタム関数の名前。
属性を非表示 属性を表示
-
trueの場合、追加の検証なしで新しいユーザーアカウントを自動的に確認します。カスタム関数アカウントの確認には、この値をfalseに設定します。値は
falseです。 -
trueの場合、新しいメール／パスワード ユーザー アカウントの登録では、確認プロセスを処理するために定義したカスタム関数が使用されます。 -
確認プロセスを取り扱うカスタム関数の名前。
-
組み込みパスワード リセット フローの一部としてユーザーに送信されるメールに含まれるURL 。このメールには、クエリ パラメータとして一意のパスワード リセット
tokenとtokenIdも追加されます。このURL は、パスワード リセット トークンをRealm SDK の
resetPassword関数に渡してユーザー確認を処理します。 -
組み込みパスワード リセット フローの一部としてユーザーに送信されるメールの件名。
属性を非表示 属性を表示
-
trueの場合、追加の検証なしで新しいユーザーアカウントを自動的に確認します。カスタム関数アカウントの確認には、この値をfalseに設定します。値は
falseです。 -
trueの場合、新しいメール／パスワード ユーザー アカウントの登録では、確認プロセスを処理するために定義したカスタム関数が使用されます。 -
確認プロセスを取り扱うカスタム関数の名前。
-
trueの場合は、定義したカスタム関数を使用してパスワード リセット プロセスを処理します。値は
trueです。 -
パスワードのリセット プロセスを取り扱うカスタム関数の名前。
-
属性を非表示 属性を表示
-
認証プロバイダの名前。カスタムJSON web token認証の場合、この値は常に
custom-tokenです。値は
custom-tokenです。 -
認証プロバイダの名前。カスタムJSON web token認証の場合、この値は常に
custom-tokenです。値は
custom-tokenです。 -
trueの場合、認証プロバイダーは無効化されます。プロバイダーが有効化されるまで、ユーザーはプロバイダー経由でログインできません。 -
カスタムJSON web token認証プロバイダの 構成オブジェクト。
設定属性を非表示にする コンフィギュレーション属性を表示 オブジェクト
-
外部JSON web token の
audクレームの期待値を定義します。 デフォルトでは 、カスタムJSON web token プロバイダーはaudがアプリIDであることを想定しています。 -
falseの場合、外部JSONウェブ トークンは、audienceクレームのaudで定義されたすべての値を含める必要があります。trueの場合、audienceで定義された値のいずれかがaudクレームに含まれていれば、JSON web token は有効です。デフォルト値は
falseです。 -
外部システムがJSON web トークンに署名するために使用する暗号化方法。 カスタムJSON web トークン認証では、次のいずれかのアルゴリズムを使用して署名された JWT がサポートされます。
- HS256
- RS256
-
trueの場合、カスタムJSON web トークン プロバイダーはJSON Web Key（JWK）またはJSON Web Key Set（JWKS）で定義された署名アルゴリズムと署名キーを使用します。JWK(S) は、jwkURIで指定されたURLでアクセスできる必要があります。 -
カスタムJSON web token プロバイダーが使用する署名方法と署名キーを記述する JWK または JWKS をホストするURL 。 JWK(S) は最大 3 つの署名キーを指定でき、 RS256アルゴリズムを使用する必要があります。
-
-
secret_config 属性を非表示 secret_config 属性の表示 オブジェクト
-
外部認証システムが JWT に署名するために使用する署名キーをそれぞれが含んでいる最大 3 つのSecretの名前のリスト。各署名キー シークレットは、32 文字と 512 文字の間の長さの string である必要があります。
-
-
メタデータ フィールドは、各ユーザーを説明する追加データです。各メタデータフィールドの値は、外部認証システムからのJSON web token に含まれるフィールドから取得されます。
ユーザーのメタデータフィールドは、ユーザーがログするたびに更新されます。
metadata_fields 属性を非表示にする metadata_fields 属性の表示 オブジェクト
ユーザーのデータを含めるための外部JSON web token からの特定のメタデータフィールド。 これにより、外部JSON web token のフィールド名（
name）が、そのフィールドの値を保持するユーザーのデータ内のフィールド名（field_name）にマッピングされます。-
trueの場合、この値は常に外部JSON web トークンに存在する必要があります。 -
データを含む外部JSON web token 内のフィールドの名前。
埋め込みオブジェクト内のフィールドを指定するには、ドット表記を使用します。
-
値を保持する ユーザーオブジェクト内のフィールドの名前。
-
属性を非表示 属性を表示
-
認証プロバイダの名前。カスタム関数認証の場合、この値は常に
custom-functionです。値は
custom-functionです。 -
認証プロバイダの名前。カスタム関数認証の場合、この値は常に
custom-functionです。値は
custom-functionです。 -
trueの場合、認証プロバイダーは無効化されます。プロバイダーが有効化されるまで、ユーザーはプロバイダー経由でログインできません。 -
カスタム関数認証プロバイダの構成オブジェクト。
設定属性を非表示 コンフィギュレーション属性を表示 オブジェクト
属性を非表示 属性を表示
-
認証プロバイダの名前。Apple認証の場合、この値は常に
oauth2-appleです。値は
oauth2-appleです。 -
認証プロバイダの名前。Apple認証の場合、この値は常に
oauth2-appleです。値は
oauth2-appleです。 -
trueの場合、認証プロバイダーは無効化されます。プロバイダーが有効化されるまで、ユーザーはプロバイダー経由でログインできません。 -
Apple認証プロバイダの構成オブジェクト。
Hide config attribute Show config attribute オブジェクト
-
あなたの Apple サービスID。
これを取得する方法については、サービスIDの作成を参照してください。
-
-
secret_config 属性を非表示 secret_config 属性の表示 オブジェクト
-
クライアントシークレットJSON web トークンを保持するシークレットの名前。
これを作成する方法については、「クライアント シークレットJSON web token の作成」を参照してください。
-
-
OAuth フローがユーザーのリダイレクトを許可する URI のリスト。
属性を非表示 属性を表示
-
認証プロバイダの名前。Google認証の場合、この値は常に
oauth2-googleです。値は
oauth2-googleです。 -
認証プロバイダの名前。Google認証の場合、この値は常に
oauth2-googleです。値は
oauth2-googleです。 -
trueの場合、認証プロバイダーは無効化されます。プロバイダーが有効化されるまで、ユーザーはプロバイダー経由でログインできません。 -
Google認証プロバイダの構成オブジェクト。
設定属性を非表示にする コンフィギュレーション属性を表示 オブジェクト
-
OAuth 2.0GCPプロジェクトのクライアントID 。
作成方法については、Google APIコンソールでのプロジェクトを設定する を参照してください。
-
An OAuth 2.0
-
-
secret_config 属性を非表示 secret_config 属性の表示 オブジェクト
-
OAuth 2.0 を保持する シークレット の名前
config.clientIdで指定されたクライアントIDのクライアント シークレット。
-
-
OAuth フローがユーザーのリダイレクトを許可する URI のリスト。
-
メタデータ フィールドは、各ユーザーを説明する追加データです。各メタデータフィールドの値は Google から取得され、認証されたJSON web token に含まれています。
ユーザーのメタデータフィールドは、ユーザーがログするたびに更新されます。
-
ユーザーアカウント用に承認された ドメイン名のリスト 。これが定義されている場合、ユーザーは、このリストに含まれるドメインを持つ OAuth プロファイルに関連付けられているメールアドレスを持っている必要があります。
属性を非表示 属性を表示
-
認証プロバイダの名前。Facebook認証の場合、この値は常に
oauth2-facebookです。値は
oauth2-facebookです。 -
認証プロバイダの名前。Facebook認証の場合、この値は常に
oauth2-facebookです。値は
oauth2-facebookです。 -
trueの場合、認証プロバイダーは無効化されます。プロバイダーが有効化されるまで、ユーザーはプロバイダー経由でログインできません。 -
Facebook認証プロバイダの構成オブジェクト。
-
secret_config 属性を非表示 secret_config 属性の表示 オブジェクト
-
Facebook App Secret を保持する シークレット の名前。
-
-
OAuth フローがユーザーのリダイレクトを許可する URI のリスト。
-
メタデータ フィールドは、各ユーザーを説明する追加データです。各メタデータフィールドの値はFacebookから取得され、認証されたJSON web token に含まれています。
ユーザーのメタデータフィールドは、ユーザーがログするたびに更新されます。
-
ユーザーアカウント用に承認された ドメイン名のリスト 。これが定義されている場合、ユーザーは、このリストに含まれるドメインを持つ OAuth プロファイルに関連付けられているメールアドレスを持っている必要があります。
-
-
custom_user_data 属性を非表示にする custom_user_data 属性の表示 object | null
-
カスタム ユーザー データが含まれるデータベースの名前。
-
カスタム ユーザー データが含まれるコレクションの名前。
-
すべてのカスタム ユーザー データ ドキュメントに表示され、各ドキュメントに対応するユーザーのユーザー アカウント ID が含まれるフィールドの名前。
-
trueの場合、カスタム ユーザー データが有効になります。 -
カスタム ユーザー データを含むリンクされたMongoDBデータソースの名前。
-
新しいユーザーが登録されるたびに実行される ユーザー作成関数 の名前。
-
-
data_api_config 属性を非表示にする data_api_config 属性を表示 object | null
-
データAPIのサポートされているバージョン。
値は
v1です。 -
データAPIエンドポイントによって返されるデフォルトのデータ形式。
値は
JSONまたはEJSONです。 -
アプリケーション ユーザーのアカウントID。定義されている場合、エンドポイントは常に指定されたユーザーとして実行されます。
-
アプリケーション ユーザーのアカウント ID を返す関数の文字列化されたソースコード。定義されている場合、エンドポイントはリクエストごとに関数を実行し、関数から返された ID を持つユーザーとして実行されます。
-
値は
NO_VALIDATION、SECRET_AS_QUERY_PARAM、またはVERIFY_PAYLOADです。 -
validation_methodが"SECRET_AS_QUERY_PARAM"または"VERIFY_PAYLOAD"に設定されている場合、これはリクエストを承認するシークレット のnameです。 -
受信リクエストへの応答としてエンドポイントの実行が許可されている場合に
trueと評価される JSON 式。
-
次の 1 つ： 属性を非表示 属性を表示
-
サービス名
-
サービスの種類
-
設定属性を非表示にする コンフィギュレーション属性を表示 オブジェクト
-
データソース内のクラスター名。名前の長さは最大 64 文字で、ASCII 文字、数字、アンダースコア、ハイフンのみを含めることができます。
-
データソースへの読み取りリクエストを行うための読み込み設定（read preference）モード
値は、
primary、primaryPreferred、secondary、secondaryPreferred、またはnearestです。 -
読み取り操作のターゲットをレプリカセットの特定のノードに設定します。
値は
server1またはserver2です。 -
true の場合、クライアントはMongoDBワイヤプロトコルを介してアプリに接続できます [非推奨] 。
-
-
より具体的な権限が定義されていないコレクションのフォールバック ユーザー ロールとクエリフィルターを定義するデータアクセスルール。
default_rule 属性を非表示 default_rule 属性の表示 オブジェクト
-
デフォルトのユーザーロールの順序付き一覧。
ロール属性を非表示にする ロール属性の表示 オブジェクト
-
document_filters 属性を非表示 document_filters 属性の表示 オブジェクト
-
ロールの名前。
読み取り
次の 1 つ： A rule expression that evaluates to
trueif the role has permission to read all fields in the document. If Device Sync is enabled, usedocument_filters.readinstead.A rule expression that evaluates to
trueif the role has permission to read all fields in the document. If Device Sync is enabled, usedocument_filters.readinstead.書込み (write)
次の 1 つ： A rule expression that evaluates to
trueif the role has permission to add, modify, or remove all fields in the document. If Device Sync is enabled, usedocument_filters.writeinstead.A rule expression that evaluates to
trueif the role has permission to add, modify, or remove all fields in the document. If Device Sync is enabled, usedocument_filters.writeinstead.検索
次の 1 つ： A rule expression that evaluates to
trueif the role has permission to search the collection using Atlas Search.A rule expression that evaluates to
trueif the role has permission to search the collection using Atlas Search.-
Field-level rules for any fields that are not explicitly configured in the role's
properties. -
Field-level rules for any fields that are not explicitly configured in the role's
properties.additional_fields 属性を非表示にする additional_fields 属性を表示 オブジェクト
-
-
デフォルトのクエリフィルターの一覧。
フィルター属性を非表示 フィルター属性の表示 オブジェクト
受信したクエリ操作を実行する前に条件付きで変更するフィルター。
-
フィルターの名前。
-
操作が実行される前に受信クエリにマージされるMongoDBクエリオブジェクト。
-
操作が実行される前に受信クエリにマージされるMongoDBプロジェクションオブジェクト。
-
-
-
リンクされたデータソース内のコレクションのユーザー ロールとクエリフィルターを定義するデータアクセスルール。
ルール属性を非表示にする ルール属性の表示 オブジェクト
リンクされたデータソース内のコレクションのユーザー ロールとクエリフィルターを定義するデータアクセスルール。
-
リンクされたデータ ソース内のデータベースの名前。
-
指定した
database内のコレクションの名前。 -
データアクセス ロールの一覧。
Hide roles attributes Show roles attributes オブジェクト
-
document_filters 属性を非表示 document_filters 属性の表示 オブジェクト
-
ロールの名前。
読み取り
次の 1 つ： A rule expression that evaluates to
trueif the role has permission to read all fields in the document. If Device Sync is enabled, usedocument_filters.readinstead.A rule expression that evaluates to
trueif the role has permission to read all fields in the document. If Device Sync is enabled, usedocument_filters.readinstead.書込み (write)
次の 1 つ： A rule expression that evaluates to
trueif the role has permission to add, modify, or remove all fields in the document. If Device Sync is enabled, usedocument_filters.writeinstead.A rule expression that evaluates to
trueif the role has permission to add, modify, or remove all fields in the document. If Device Sync is enabled, usedocument_filters.writeinstead.検索
次の 1 つ： A rule expression that evaluates to
trueif the role has permission to search the collection using Atlas Search.A rule expression that evaluates to
trueif the role has permission to search the collection using Atlas Search.-
Field-level rules for any fields that are not explicitly configured in the role's
properties. -
Field-level rules for any fields that are not explicitly configured in the role's
properties.additional_fields 属性を非表示にする additional_fields 属性を表示 オブジェクト
-
-
受信操作のフィルターのリスト。
Hide filters attributes Show filters attributes オブジェクト
受信したクエリ操作を実行する前に条件付きで変更するフィルター。
-
フィルターの名前。
-
A MongoDB query object that is merged into an incoming query before the operation runs.
-
A MongoDB projection object that is merged into an incoming query before the operation runs.
-
-
-
-
エンドポイント属性の非表示 エンドポイント属性の表示 オブジェクト
-
環境属性を非表示 環境属性の表示 オブジェクト
-
可能なそれぞれの環境名を、その環境で使用可能な環境値の定義にマッピングするオブジェクト。
-
-
関数の属性を非表示にする 関数の属性を表示する オブジェクト
-
受信リクエストに応じて関数の実行が許可されている場合に
trueと評価される JSON 式。 -
関数のユニークな名前。
-
trueの場合、関数はクライアント アプリケーションから非表示になります。受信 Webhook や Triggers などの JSON 式やその他の関数からプライベート関数を呼び出すこともできます。 -
関数の文字列化されたソースコード。コードは有効な ES6 である必要があります。
-
trueの場合、関数はすべてのサービスに対するルールをバイパスして完全な権限で実行されます。 -
アプリケーション ユーザーのアカウントID。定義されている場合、エンドポイントは常に指定されたユーザーとして実行されます。
run_as_user_id_script_sourceとは併用できません。 -
アプリケーションユーザーのアカウントIDを返す関数の文字列化されたソースコード。定義されている場合、エンドポイントはリクエストごとに関数を実行し、関数から返されたIDを持つユーザーとして実行されます。
run_as_user_idとは併用できません。
-
-
GraphQL属性を非表示にする GraphQL属性の表示 オブジェクト
-
設定属性を非表示にする コンフィギュレーション属性を表示 オブジェクト
-
trueの場合、生成されたスキーマ型名では、可能な限り一般的な英語の複数形が使用されます。falseの場合、または自然な複数形を決定できない場合、複数形の型では、末尾に"s"が追加された単数形の型名が使用されます。アプリを作成した後、この値を変更することはできません。この値は、すべての新しいアプリでは
trueです。 -
trueの場合、GraphQL API はクライアントからの イントロスペクション クエリ をブロックします。
-
-
custom_resolvers 属性を非表示にする custom_resolvers 属性の表示 オブジェクト
-
リゾルバの親型の名前。これは、
"Query"、"Mutation"、または計算プロパティの場合は生成された型の名前になります。 -
GraphQL スキーマに表示されるカスタム リゾルバ フィールドの名前。
-
カスタム リゾルバが使用する入力タイプの種類。この値は、次の値と一致する必要があります
input_type- スカラー入力型は
"scalar"または"scalar-list"を使用する必要があります - 生成された入力タイプでは、
"generated"または"generated-list"を使用する必要があります。 - カスタム入力型では、
"custom"
未定義の場合、リゾルバは入力を受け入れません。
値は、
scalar、scalar-list、generated、generated-list、またはcustomです。 - スカラー入力型は
-
カスタム リゾルバが使用するペイロード型の種類。この値は、次の値と一致する必要があります
payload_type- スカラーペイロード型は
"scalar"または"scalar-list"を使用する必要があります - 生成されたペイロード型では
"generated"または"generated-list"を使用する必要があります - カスタムペイロード型では、
"custom"
未定義の場合、リゾルバは
DefaultPayloadオブジェクトを返します。値は、
scalar、scalar-list、generated、generated-list、またはcustomです。 - スカラーペイロード型は
-
リゾルバ 関数の名前。
-
-
-
[非推奨] レガシー HTTP サービス一覧。下位互換性の確保のみを目的としたリストです。
https_endpoints 属性を非表示にする https_endpoints 属性を表示 オブジェクト
-
サービス名
-
サービスの種類
値は、
aws、twilio、github、gcm、またはhttpです。
-
-
log_forwarders 属性を非表示にする log_forwarders 属性の表示 オブジェクト
-
値は、
auth、endpoint、function、graphql、push、schema、service、sync、trigger、またはtrigger_error_handlerです。 -
値は
errorまたはsuccessです。
-
スキーマ属性を非表示にする スキーマ属性の表示 オブジェクト
-
スキーマが適用される、リンクされたコレクションを記述するメタデータ。
-
コレクションに対する有効なスキーマ。
スキーマ属性の非表示 スキーマ属性の表示 オブジェクト
-
フィールドのBSON type。
Values are
object,array,string,number,int,long,double,decimal,date,timestamp,bool,null,regex,objectId,binary,uuid,function,javascript,symbol,minKey, ormaxKey. -
スキーマの人間が判読可能なタイトル。
-
objectスキーマの場合、オブジェクトのインスタンスに必要なフィールド名の配列。 -
各フィールド名がスキーマ内のプロパティであるオブジェクト。対応する値は、そのフィールドのスキーマ定義です。
プロパティ属性を非表示 プロパティ属性を表示 オブジェクト
-
コレクションに対する有効なスキーマ。
-
-
-
外部コレクションとの関係。各フィールド名はスキーマ内のプロパティです。対応する値は、そのフィールドの関係の定義です。
関係属性を非表示 関係属性の表示 オブジェクト
-
関係の定義。
-
-
-
[非推奨] レガシー サードパーティー製非 HTTP サービス一覧。下位互換性の確保のみを目的としたリストです。
サービス属性の非表示 サービス属性の表示 オブジェクト
-
サービス名
-
サービスの種類
値は、
aws、twilio、github、gcm、またはhttpです。
-
-
同期属性の非表示 同期属性の表示 オブジェクト
-
同期サービスの状態（同期が構成されていない場合は、
"enabled"、"disabled"、または空）。 -
App Services が開発モード でデータを保存する同期されたクラスター内のデータベースの名前。App Services は、同期された各型のスキーマを自動的に生成し、各オブジェクト型をデータベース内のコレクションにマッピングします。
-
インデックス付きクエリ可能なフィールドとして使用するフィールド名のリスト。このプロパティは配列ですが、Sync は現在、インデックス付きクエリ可能なフィールド の1 つのみをサポートしています。したがって、この配列には最大 1 つの要素を含めることができます。
インデックス付きクエリ可能なフィールドはスキーマ内に存在し、同期するすべてのコレクションで同じ適格なフィールド型である必要があります。このはグローバルなクエリ可能なフィールドであるため、インデックス付きクエリ可能なフィールド名は
queryable_fields_namesにも表示される必要があります。 -
指定されたコレクションのクエリ可能なフィールド名の配列。
-
非推奨
-
同期 が最後に無効になった時刻は、UNIX エポックからの秒数により表示されます。
-
クライアントリセットが必要になるまでにクライアントがオフラインになることができる日数。
-
クライアントリセットモードを無効にするかどうかを指定します。デフォルトでは 、クライアントリセットモードが有効になっており、この値は
falseです。 -
Data Ingestで非対称として定義されているコレクションの名前の配列。クライアントはデータを書込むことができますが、読み取りはできません。
-
-
次の 1 つ： 属性を非表示 属性を表示
-
trigger 名。
-
Triggers の種類。データベース Triggers の場合、この値は常に
"DATABASE"になります。値は
DATABASEです。 -
trueの場合、trigger は無効になり、イベントをリスニングしたり実行したりしません。デフォルト値は
falseです。 -
trigger の構成値を定義するオブジェクト。
設定属性を非表示にする コンフィギュレーション属性を表示 オブジェクト
-
監視対象のコレクションを含むリンクされたMongoDBデータソースの
_id値。すべてのサービスを取得するエンドポイントを使用してサービスを一覧表示できます。
データソースは、
typeが「mongodb-atlas」であるサービスです。 trigger にリンクするデータソースには_id値を使用します。 -
リンクされたデータソース内のデータベースの名前。このパラメーターを省略すると、ソース タイプは "Deployment" に変わります。ただし、共有階層インフラストラクチャは配置の変更ストリームをサポートしていません。「データベース」パラメーターを省略すると、「配置の変更ストリームは共有層クラスターではサポートされていません」というエラーが返されます。このエラーを解決するには、データベースパラメータを指定します。
-
指定したデータベース内のコレクションの名前。trigger は、このコレクションのイベントをリッスンします。このパラメーターを省略すると、ソース タイプは「データベース」に変わります。
-
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 構成を参照してください。
At least
1element. -
$match式は変更イベントをフィルタリングします。trigger は、特定の 変更イベントに対して式が true と評価された場合にのみ起動します。
-
$プロジェクト式は、指定されたフィールドのみを返します。特定のフィールドを含めたり除外したり、新しく計算されたフィールドを含めたりすることができます。
-
trueの場合、UPDATE変更イベントには、修正されたドキュメントの最新の 過半数がコミットした バージョンをfullDocumentフィールドに含める必要があることを示します。デフォルト値は
falseです。 -
true の場合、 は
UPDATE変更イベントに更新が適用される直前の変更されたドキュメントのスナップショットを含める必要があることを示します。これらのスナップショットを含めるには、クラスターでドキュメントプレイメージを有効にする必要があります。
デフォルト値は
falseです。 -
trueの場合、trigger を無効にした後に trigger を有効にしても、trigger が無効になっている間に発生したイベントは呼び出されません。デフォルト値は
falseです。 -
trueの場合、この trigger の再開トークンがクラスターのoplogに見つからない場合、trigger は次の関連する変更ストリームイベントでイベントの情報処理を自動的に再開します。trigger が一時停止されてから trigger が実行を再開するまでのすべての変更ストリームイベントでは、trigger は起動しません。デフォルト値は
falseです。 -
trueの場合、trigger は最大スループットオプションを使用します。デフォルト値は
falseです。 -
trueの場合、イベント順序は無効になり、この trigger はイベントを並列に処理できます。falseの場合、イベントの順序付けが有効になり、trigger はイベントを連続して実行します。デフォルト値は
falseです。
-
-
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のいずれかを指定する必要があります。 -
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のいずれかを指定する必要があります。 -
App Services バックエンドは、値が定義されていない構成の場所に値を複製します。設定オブジェクトの例については、「AWS EventBridge へのトリガーイベントの送信」を参照してください。
event_processors 属性を非表示にする event_processors 属性の表示 オブジェクト
-
FUNCTION 属性を非表示 FUNCTION 属性の表示 オブジェクト
-
設定属性を非表示にする コンフィギュレーション属性を表示 オブジェクト
-
trigger が起動時に呼び出す関数の ID。
この値はルートレベルの
function_idと同じです。ここで値を定義することも、function_idで値を定義することもできます。App Servicesバックエンドは、値が定義されていない構成の場所に値を複製します。たとえば、
event_processors.FUNCTION.function_idを定義すると、バックエンドはそれをfunction_idに複製します。function_idを定義する場合、event_processorsは必要ありません。trigger を更新するときは、function_idまたはevent_processorsのいずれかを指定する必要があります。 -
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 Triggers のカスタムエラー処理を定義するオブジェクト。
"AWS_EVENTBRIDGE"イベント プロセッサーを持つ"DATABASE"型の Triggers に対してのみ有効です。
属性を非表示 属性を表示
-
trigger 名。
-
trigger の種類。認証trigger の場合、この値は常に
"AUTHENTICATION"になります。値は
AUTHENTICATIONです。 -
trueの場合、trigger は無効になり、イベントをリスニングしたり実行したりしません。デフォルト値は
falseです。 -
trigger の構成値を定義するオブジェクト。
設定属性を非表示にする コンフィギュレーション属性を表示 オブジェクト
-
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のいずれかを指定する必要があります。 -
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のいずれかを指定する必要があります。 -
App Services バックエンドは、値が定義されていない構成の場所に値を複製します。設定オブジェクトの例については、「AWS EventBridge へのトリガーイベントの送信」を参照してください。
event_processors 属性を非表示にする event_processors 属性の表示 オブジェクト
-
FUNCTION 属性を非表示 FUNCTION 属性の表示 オブジェクト
-
設定属性を非表示にする コンフィギュレーション属性を表示 オブジェクト
-
trigger が起動時に呼び出す関数の ID。
この値はルートレベルの
function_idと同じです。ここで値を定義することも、function_idで値を定義することもできます。App Servicesバックエンドは、値が定義されていない構成の場所に値を複製します。たとえば、
event_processors.FUNCTION.function_idを定義すると、バックエンドはそれをfunction_idに複製します。function_idを定義する場合、event_processorsは必要ありません。trigger を更新するときは、function_idまたはevent_processorsのいずれかを指定する必要があります。 -
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のいずれかを指定する必要があります。
-
-
-
属性を非表示 属性を表示
-
trigger 名。
-
trigger の種類。スケジュールされた trigger の場合、この値は常に
"SCHEDULED"になります。値は
SCHEDULEDです。 -
trueの場合、trigger は無効になり、イベントをリスニングしたり実行したりしません。デフォルト値は
falseです。 -
trigger の構成値を定義するオブジェクト。
設定属性を非表示にする コンフィギュレーション属性を表示 オブジェクト
-
trigger が実行されるタイミングを指定する cron式。
-
trueの場合、trigger を無効にした後に有効にしても、trigger が無効になっている間に発生したイベントは呼び出されません。
-
-
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のいずれかを指定する必要があります。 -
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のいずれかを指定する必要があります。 -
App Services バックエンドは、値が定義されていない構成の場所に値を複製します。設定オブジェクトの例については、「AWS EventBridge へのトリガーイベントの送信」を参照してください。
event_processors 属性を非表示にする event_processors 属性の表示 オブジェクト
-
FUNCTION 属性を非表示 FUNCTION 属性の表示 オブジェクト
-
設定属性を非表示にする コンフィギュレーション属性を表示 オブジェクト
-
trigger が起動時に呼び出す関数の ID。
この値はルートレベルの
function_idと同じです。ここで値を定義することも、function_idで値を定義することもできます。App Servicesバックエンドは、値が定義されていない構成の場所に値を複製します。たとえば、
event_processors.FUNCTION.function_idを定義すると、バックエンドはそれをfunction_idに複製します。function_idを定義する場合、event_processorsは必要ありません。trigger を更新するときは、function_idまたはevent_processorsのいずれかを指定する必要があります。 -
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のいずれかを指定する必要があります。
-
-
-
-
-
Hide values attributes 値属性を表示する オブジェクト
-
trueの場合、値は Secret への名前による参照です。
アプリ構成ファイルのディレクトリを含む圧縮ファイル
-
-
Invalid request
-
構成のプル中にエラーが発生しました
curl \
--request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/pull' \
--header "Authorization: Bearer $ACCESS_TOKEN"{
"name": "string",
"provider_region": "aws-us-east-1",
"deployment_model": "GLOBAL",
"environment": "production",
"auth_providers": [
{
"name": "anon-user",
"type": "anon-user",
"disabled": true
}
],
"custom_user_data": {
"database_name": "myapp",
"collection_name": "users",
"user_id_field": "user_account_id",
"enabled": true,
"mongo_service_name": "mongodb-atlas",
"on_user_creation_function_name": "myFunction"
},
"data_api_config": {
"disabled": true,
"versions": [
"v1"
],
"return_type": "JSON",
"create_user_on_auth": true,
"run_as_user_id": "string",
"run_as_user_id_script_source": "string",
"validation_method": "NO_VALIDATION",
"secret_name": "string",
"can_evaluate": {}
},
"data_sources": [
{
"name": "string",
"type": "string",
"config": {
"clusterName": "Cluster0",
"readPreference": "primary",
"readPreferenceTagSets": [
"server1"
],
"wireProtocolEnabled": true
},
"default_rule": {
"roles": [
{
"document_filters": {},
"name": "string",
"fields": {},
"additional_fields": {}
}
],
"filters": [
{
"name": "string",
"query": {},
"projection": {
"additionalProperty1": 0,
"additionalProperty2": 0
}
}
]
},
"rules": [
{
"database": "string",
"collection": "string",
"roles": [
{
"document_filters": {},
"name": "string",
"fields": {},
"additional_fields": {}
}
],
"filters": [
{
"name": "string",
"query": {},
"projection": {
"additionalProperty1": 0,
"additionalProperty2": 0
}
}
]
}
]
}
],
"endpoints": [
{
"route": "string",
"http_method": "GET",
"function_id": "string",
"validation_method": "NO_VALIDATION",
"secret_id": "string",
"return_type": "JSON",
"respond_result": true,
"fetch_custom_user_data": true,
"create_user_on_auth": true,
"disabled": true,
"function_name": "string"
}
],
"environments": {
"values": {
"none": {
"values": {}
},
"development": {
"values": {}
},
"testing": {
"values": {}
},
"qa": {
"values": {}
},
"production": {
"values": {}
}
}
},
"functions": [
{
"can_evaluate": {},
"name": "string",
"private": true,
"source": "string",
"run_as_system": true,
"run_as_user_id": "string",
"run_as_user_id_script_source": "string"
}
],
"graphql": {
"config": {
"use_natural_pluralization": true,
"disable_schema_introspection": true
},
"validation_settings": {
"read_validation_action": "ERROR",
"read_validation_level": "STRICT",
"write_validation_action": "ERROR",
"write_validation_level": "STRICT"
},
"custom_resolvers": [
{
"on_type": "string",
"field_name": "string",
"input_type": "string",
"input_type_format": "scalar",
"payload_type": "string",
"payload_type_format": "scalar",
"function_name": "string"
}
]
},
"hosting": {
"enabled": true,
"custom_domain": "example.com",
"default_error_path": "/404.html",
"default_error_code": "404"
},
"https_endpoints": [
{
"name": "string",
"type": "aws",
"incoming_webhooks": [
{
"name": "string",
"function_source": "string",
"respond_result": true,
"options": {
"secret": "string",
"secretAsQueryParam": true
}
}
],
"version": 42
}
],
"log_forwarders": [
{
"name": "string",
"disabled": true,
"log_types": [
"auth"
],
"log_statuses": [
"error"
],
"policy": {
"type": "single"
},
"action": {
"type": "collection",
"name": "string",
"data_source": "string",
"database": "string",
"collection": "string"
}
}
],
"schemas": [
{
"metadata": {
"data_source": "string",
"database": "string",
"collection": "string"
},
"schema": {
"bsonType": "object",
"title": "string",
"required": [
"string"
],
"properties": {
"*": {}
}
},
"relationships": {
"additionalProperty1": {
"ref": "string",
"foreign_key": "string",
"is_list": true
},
"additionalProperty2": {
"ref": "string",
"foreign_key": "string",
"is_list": true
}
}
}
],
"services": [
{
"name": "string",
"type": "aws",
"incoming_webhooks": [
{
"name": "string",
"function_source": "string",
"respond_result": true,
"options": {
"secret": "string",
"secretAsQueryParam": true
}
}
],
"version": 42
}
],
"sync": {
"state": "string",
"database_name": "string",
"queryable_fields_names": [
"string"
],
"indexed_queryable_fields_names": [
"string"
],
"collection_queryable_fields_names": {
"additionalProperty1": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"additionalProperty2": {
"additionalProperty1": "string",
"additionalProperty2": "string"
}
},
"permissions": {},
"last_disabled": "string",
"client_max_offline_days": 42,
"is_recovery_mode_disabled": true,
"asymmetric_tables": [
"string"
]
},
"triggers": [
{
"name": "onNewEmployee",
"type": "DATABASE",
"function_id": "5eea9ca4ca0e356e2c2a148a",
"config": {
"operation_types": [
"INSERT"
],
"database": "HR",
"collection": "employees",
"service_id": "5adeb649b8b998486770ae7c",
"match": {},
"project": {},
"full_document": true
},
"event_processors": {
"FUNCTION": {
"config": {
"function_id": "6841b8d3e71dc81bed89dbba",
"function_name": "Atlas_Triggers_DatabaseInsert_1749137618"
}
}
}
}
],
"values": [
{
"name": "string",
"private": true,
"from_secret": true
}
]
}