path パラメータ

• グループ ID string 必須

  プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。

  注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

  形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

クエリ パラメータ

• envelope ブール値

  アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

  デフォルト値はfalseです。

• pretty ブール値

  レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

  デフォルト値はfalseです。

  Prettyprint
• skipRoleValidation ブール値

  このリクエストで、リクエスト元 IAM ロールの S3 バケット読み取り可否を確認するかどうかを示すフラグ。AWS は、バケットに書き込む前に、ロールがバケット内のオブジェクトを一覧できるかどうかを確認します。一部の IAM ロールには書き込み権限のみが必要です。このフラグを使用すると、そのチェックをスキップできます。

  デフォルト値はfalseです。

応答

• 200 application/ JSON

  OK

  応答属性の非表示 応答属性の表示 オブジェクト

  • cloudProviderConfig オブジェクト

    このフェデレーティッドデータベースインスタンスがホストされているクラウドプロバイダー。

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

    • Amazon Web Services オブジェクト

      AWSで Data Federation を実行中ための構成。

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

      • externalId string

        データレイクがデータ ストアにアクセスするときに引き受ける IAM（Identity and Access Management、ID とアクセス管理）ロールに関連付けられた一意の識別子です。

      • IAMAssumedRoleARN string

        データレイクがデータストアにアクセスするときに引き受ける IAM（Identity and Access Management、ID とアクセス管理）ロールのAmazonリソース名（ARN）。

        最小長は 20、最大長は 2048 です。

      • iamUserARN string

        データレイクがデータストアにアクセスするときに引き受けるユーザーのAmazonリソース名（ARN） 。

      • roleId string 必須

        Data Lake がデータ ストアにアクセスするために使用できるロールの一意な識別子です。cloudProviderConfig を指定する場合は必須です。

        形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

    • Azure オブジェクト

      Azureで Data Federation を実行中ための構成。

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

      • atlasAppId string

        サービス プリンシパルのアクセス ポリシーのために Atlas によって生成されたアプリID 。

      • roleId string 必須

        Data Federation がデータ ストアにアクセスするために使用できるロールの一意な識別子です。 cloudProviderConfig を指定する場合は必須です。

        形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

      • servicePrincipalId string

        Atlas がAzureリソースにアクセスするためのアクセス ポリシーが存在するサービス プリンシパルのID 。

      • tenantId string

        サービス プリンシパルに関連付けられたAzure Active Directory / Entra ID のテナントID 。

    • gcp オブジェクト

      GCPで Data Federation を実行中ための構成。

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

      • gcpServiceAccount string

        Atlas によって作成され、Atlas が Google Cloud Storage にアクセスできるようにするために認可されるGoogle Cloud Platform （GCP ）サービス アカウントのメールアドレス。

      • roleId string 必須

        Data Federation がデータ ストアにアクセスするために使用できるロールの一意な識別子です。 cloudProviderConfig を指定する場合は必須です。

        形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

  • dataProcessRegion オブジェクト

    フェデレーティッドデータベースインスタンスがクライアント接続をルーティングするクラウドプロバイダーのリージョンに関する情報。

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

    • cloudProvider string 必須

      フェデレーティッドデータベースインスタンスのインフラストラクチャをホストするクラウドサービスの名前。

      値は AWS、AZURE、または GCP です。

    • リージョン string 必須

      Data Lake がクライアント接続をルーティングするリージョンの名前。

      次の 1 つ：

      ApiAtlasDataLakeAWSRegionView string AtlasDataFederationAzureRegion string AtlasDataFederationGPRegion string

      Atlas Data Federation AWSリージョン。

      値は、SYDNEY_AUS、MUMBAI_IND、FRANKFURT_DEU、DUBLIN_IRL、LONDON_GBR、VIRGINIA_USA、OREGON_USA、SAOPAULO_BRA、MONTREAL_CAN、TOKYO_JPN、SEOUL_KOR、または SINGAPORE_SGP 。

      Atlas Data Federation Azureリージョン。

      値は VIRGINIA_USA、AMSTERDAM_NLD、または SAOPAULO_BRA です。

      Atlas Data Federation GCPリージョン。

      値は IOWA_USA または BELGIUM_EU です。

  • グループ ID string

    プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。

    形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

  • hostnames array[string]

    フェデレーティッドデータベースインスタンスに割り当てられたホスト名が格納されたリスト。

  • name string

    フェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。

  • privateEndpointHostnames array[オブジェクト]

    プライベートエンドポイントとホスト名のセットが格納されたリスト。

    プライベートエンドポイントとホスト名のセット。

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

    • Hostname string

      ホスト名を識別する、人間が判読可能なラベル。

    • privateEndpoint string

      プライベートエンドポイントを識別する、人間が判読可能なラベル。

  • 状態 string

    フェデレーティッドデータベースインスタンスのステータスを示すラベル。

    値は UNVERIFIED、ACTIVE、または DELETED です。

  • ストレージ オブジェクト

    各データ ストアの構成情報と MongoDB Cloud データベースへのマッピング。

    ストレージ属性の非表示 ストレージ属性の表示 オブジェクト

    • databases array[オブジェクト]

      この Data Lake のクエリ可能なデータベースとコレクションを含む配列。

      この Data Lake に関連付けられているデータベース。データベースにはコレクションとビューが含まれています。

      データベース属性の非表示 データベース属性の表示 オブジェクト

      • collections array[オブジェクト]

        stores データストアにマッピングするコレクションとデータソースの配列。

        stores データストアにマッピングするコレクションとデータソース。

        コレクション属性を非表示にする コレクション属性を表示する オブジェクト

        • dataSources array[オブジェクト]

          この Data Lake のコレクションにマップされるデータ ストアを含む配列。

          この Data Lake のコレクションにマッピングするデータ ストア。

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

          • allowInsecure ブール値

            指定された URL のスキームを検証するフラグ。 true の場合、安全でない HTTP スキームを許可し、サーバーの証明書チェーンとホスト名を検証せず、サーバーによって提示されたホスト名を持つ任意の証明書を受け入れます。 false の場合、安全な HTTPS スキームのみを許可します。

            デフォルト値はfalseです。

          • コレクション string

            データベース内のコレクションを識別する、人間が判読可能なラベル。ワイルドカード（*）コレクションを作成する場合は、このパラメータを省略する必要があります。

          • collectionRegex string

            ワイルドカード（*）コレクションの作成に使用する正規表現パターン。正規表現構文の詳細については、 Goプログラミング言語 を参照してください。

          • database string

            クラスター内のコレクションを含むデータベースを識別する、人間が判読可能なラベル。動的に生成されたデータベースのワイルドカード（*）コレクションを生成するには、このパラメーターを省略する必要があります。

          • databaseRegex string

            ワイルドカード（*）データベースの作成に使用する正規表現パターン。正規表現構文の詳細については、 Goプログラミング言語 を参照してください。

          • datasetName string

            取り込みパイプラインの実行または Online アーカイブ用に Atlas が生成するデータセットを識別する、人間が判読可能なラベル。

          • datasetPrefix string

            取り込みパイプライン実行またはオンラインアーカイブのデータセット名と一致する、人間が判読可能なラベル。

          • defaultFormat string

            MongoDB Cloud が storageName を検索中にファイル拡張子のないファイルを検出した場合にMongoDB Cloud が使用するファイル形式。

            値は .avro、.avro.bz2、.avro.gz、.bson、.bson.bz2、.bson.gz、.bsonx、.csv、.csv.bz2、.csv.gz、.json、.json.bz2、 .json.gz、.orc、.parquet、.tsv、.tsv.bz2、または .tsv.gz 。

          • path string

            MongoDB Cloud が StoreName 内のファイルをコレクションにマッピングする前に、それらのファイルを検索して解析する方法を制御するファイルパス。/ パスからすべてのファイルとフォルダーを取得するには、prefix を指定します。

          • deliveryFieldName string

            結果にドキュメントの出所が含まれるフィールドの名前。 MongoDB Cloud では、サポートされているプロバイダーごとに結果に異なるフィールドが返されます。

          • StoreName string

            MongoDB Cloud がコレクションにマッピングするデータ ストアを識別する、人間に判読可能なラベル。

          • rimLevel integer(int32)

            残りのフィールドをワイルドカードコレクション名にマッピングする前に、データセット名の左側から削除するデータセット名のフィールドの数を指定する符号なし整数。

          • urls array[string]

            一般にアクセス可能なデータファイルの URL 。認証を必要とする URL は指定できません。 Atlas Data Lake は、各URLのパーティションを作成します。空または省略した場合、Data Lake は dataSources.storeName パラメーターで指定されたストアの URL を使用します。

        • name string

          MongoDB Cloud がデータ ストア内のデータをマッピングするコレクションを識別する、人間に判読可能なラベル。

      • maxWildcardCollections integer(int32)

        データベース内のワイルドカード コレクションの最大数。これは S3 データソースにのみ適用されます。

        最小値は 1、最大値は 1000 です。デフォルト値は 100 です。

      • name string

        Data Lake がデータをマッピングするデータベースを識別する、人間が判読可能なラベル。

      • ビュー array[オブジェクト]

        コレクションに適用される集計パイプラインの配列。これは S3 データソースにのみ適用されます。

        コレクションに適用される集計パイプライン。

        ビュー属性を非表示にする ビュー属性を表示する オブジェクト

        • name string

          コレクションの 集計パイプライン に対応するビューを識別する、人間が判読可能なラベル。

        • パイプライン string

          ソース コレクションに適用する 集計パイプライン ステージ 。

          集計パイプライン
        • ソース string

          ビューのソース コレクションを識別する、人間が判読可能なラベル。

    • stores array[オブジェクト]

      データレイクのデータ ストアを含む配列。

      次の 1 つ：

      s3 オブジェクト dls:awsオブジェクト dls: azure オブジェクト dls:gcpオブジェクト atlas object HTTPオブジェクト azureオブジェクト gcsオブジェクト

      データを保存する場所を定義する 設定のグループ。

      属性を非表示 属性を表示

      • name string

        データ ストアを識別する、人間が判読可能なラベル。 databases.[n].collections.[n].dataSources.[n].storeNameフィールドは、マッピング構成の一部としてこの値を参照します。 MongoDB Cloud をデータストアとして使用するには、データレイクにサーバーレスインスタンスまたはM10 以上のクラスターが必要です。

      • プロバイダー string 必須 弁別子

        値は s3 です。

      • additionalStorageClasses array[string]

        AWS S3 ストレージクラス のコレクション。 Atlas Data Lake では、これらのストレージクラスのファイルがクエリ結果に含まれます。

        値は STANDARD、INTELLIGENT_TIERING、または STANDARD_IA です。

      • バケット string

        AWS S3バケットを識別する、人間が判読可能なラベル。このラベルは、設定されたAWS Identity and Access Management（IAM）認証情報を使用してデータレイクがアクセスできる S3バケットの名前と完全に一致する必要があります。

      • delimiter string

        データストア内のデータベース.[n]コレクション.[n].dataSources.[n].パス セグメントを区切る区切り文字。 MongoDB Cloud は区切り文字を使用して、階層的なディレクトリ構造の3 S3 バケットを効率的に走査します。 S オブジェクトキー でサポートされている任意の文字を区切り文字として指定できます。例、区切り文字としてアンダースコア（）またはプラス記号（+）、または複数の文字（ダブルアンダースコア（_）など）を指定できます。省略した場合、デフォルトは /になります。

      • includeTags ブール値

        指定されたパス内のファイルの S3 タグを追加のパーティション属性として使用するかどうかを示すフラグ。 trueに設定すると、データレイクは S3 タグを追加のパーティション属性として追加し、各タグを各ドキュメントに関連付けるための新しい最上位のBSON要素を追加します。

        デフォルト値はfalseです。

      • prefix string

        S バケット内のファイルを検索するときにMongoDB Cloud3 が適用するプレフィックス。データ ストアは、プレフィックス の値をデータベース.[n].collections.[n].dataSources.[n].path の先頭に追加して、取り込むファイルの完全なパスを作成します。省略した場合、 MongoDB Cloud は S3 バケットのルートからすべてのファイルを検索します。

      • public ブール値

        バケットがパブリックかどうかを示すフラグ。 true に設定すると、 MongoDB Cloud は S3バケットにアクセスするために、設定されたAWS IAM（Identity and Access Management、ID とアクセス管理）ロールを使用しません。 false に設定されている場合、設定されたAWS IAM ロールには S3バケットにアクセスするための権限が含まれている必要があります。

        デフォルト値はfalseです。

      • リージョン string

        MongoDB Cloud がAWSでホストされているMongoDBクラスター ノードを配置する物理的なロケーション。選択したリージョンは、データベースにアクセスするクライアントのネットワークレイテンシに影響する可能性があります。MongoDB Cloud は専有クラスターを配置するときに、そのプロバイダーとリージョンにVPCまたはVPC接続が存在するかどうかを確認します。変換できない場合、 MongoDB Cloud は配置の一部としてそれらを作成します。MongoDB Cloud はVPCに CIDR ブロックを割り当てます。新しいVPCピアリング接続を 1 つの CIDR ブロックとリージョンに制限するには、最初に接続を作成します。接続が開始された後にクラスターを配置します。

        値は US_GOV_WEST_1、US_GOV_EAST_1、US_EAST_1、US_EAST_2、US_WEST_1、US_WEST_2、CA_CENTRAL_1、EU_NORTH_1、EU_WEST_1、EU_WEST_2、EU_WEST_3、EU_CENTRAL_1、 EU_CENTRAL_2、AP_EAST_1、AP_NORTHEAST_1、AP_NORTHEAST_2、AP_NORTHEAST_3、AP_SOUTHEAST_1、AP_SOUTHEAST_2、AP_SOUTHEAST_3、AP_SOUTHEAST_4、AP_SOUTH_1、AP_SOUTH_2、SA_EAST_1、CN_NORTH_1、CN_NORTHWEST_1、ME_SOUTH_1、ME_CENTRAL_1、AF_SOUTH_1、EU_SOUTH_1、EU_SOUTH_2、IL_CENTRAL_1、CA_WEST_1、または GLOBAL 。

      データを保存する場所を定義する 設定のグループ。

      属性を非表示 属性を表示

      • name string

        データ ストアを識別する、人間が判読可能なラベル。 databases.[n].collections.[n].dataSources.[n].storeNameフィールドは、マッピング構成の一部としてこの値を参照します。 MongoDB Cloud をデータストアとして使用するには、データレイクにサーバーレスインスタンスまたはM10 以上のクラスターが必要です。

      • プロバイダー string 必須 弁別子

        値は dls:aws です。

      • リージョン string

        MongoDB Cloud がAWSでホストされているMongoDBクラスター ノードを配置する物理的なロケーション。選択したリージョンは、データベースにアクセスするクライアントのネットワークレイテンシに影響する可能性があります。MongoDB Cloud は専有クラスターを配置するときに、そのプロバイダーとリージョンにVPCまたはVPC接続が存在するかどうかを確認します。変換できない場合、 MongoDB Cloud は配置の一部としてそれらを作成します。MongoDB Cloud はVPCに CIDR ブロックを割り当てます。新しいVPCピアリング接続を 1 つの CIDR ブロックとリージョンに制限するには、最初に接続を作成します。接続が開始された後にクラスターを配置します。

        値は US_GOV_WEST_1、US_GOV_EAST_1、US_EAST_1、US_EAST_2、US_WEST_1、US_WEST_2、CA_CENTRAL_1、EU_NORTH_1、EU_WEST_1、EU_WEST_2、EU_WEST_3、EU_CENTRAL_1、 EU_CENTRAL_2、AP_EAST_1、AP_NORTHEAST_1、AP_NORTHEAST_2、AP_NORTHEAST_3、AP_SOUTHEAST_1、AP_SOUTHEAST_2、AP_SOUTHEAST_3、AP_SOUTHEAST_4、AP_SOUTH_1、AP_SOUTH_2、SA_EAST_1、CN_NORTH_1、CN_NORTHWEST_1、ME_SOUTH_1、ME_CENTRAL_1、AF_SOUTH_1、EU_SOUTH_1、EU_SOUTH_2、IL_CENTRAL_1、CA_WEST_1、または GLOBAL 。

      データを保存する場所を定義する 設定のグループ。

      属性を非表示 属性を表示

      • name string

        データ ストアを識別する、人間が判読可能なラベル。 databases.[n].collections.[n].dataSources.[n].storeNameフィールドは、マッピング構成の一部としてこの値を参照します。 MongoDB Cloud をデータストアとして使用するには、データレイクにサーバーレスインスタンスまたはM10 以上のクラスターが必要です。

      • プロバイダー string 必須 弁別子

        値は dls:azure です。

      • リージョン string

        Microsoft Azureリージョン。

        値は US_CENTRAL、US_EAST、US_EAST_2、US_NORTH_CENTRAL、US_WEST、US_SOUTH_CENTRAL、EUROPE_NORTH、EUROPE_WEST、US_WEST_CENTRAL、US_WEST_2、US_WEST_3、CANADA_EAST、 CANADA_CENTRAL、BRAZIL_SOUTH、BRAZIL_SOUTHEAST、AUSTRALIA_CENTRAL、AUSTRALIA_CENTRAL_2、AUSTRALIA_EAST、AUSTRALIA_SOUTH_EAST、GERMANY_CENTRAL、GERMANY_NORTH_EAST、GERMANY_WEST_CENTRAL、GERMANY_NORTH、SWEDEN_CENTRAL、SWEDEN_SOUTH、SWITZERLAND_NORTH、SWITZERLAND_WEST、UK_SOUTH、UK_WEST、NORWAY_EAST、NORWAY_WEST、INDIA_CENTRAL、INDIA_SOUTH、INDIA_WEST、CHINA_EAST、CHINA_NORTH、ASIA_EAST、 JAPAN_EAST、JAPAN_WEST、ASIA_SOUTH_EAST、KOREA_CENTRAL、KOREA_SOUTH、FRANCE_CENTRAL、FRANCE_SOUTH、SOUTH_AFRICA_NORTH、SOUTH_AFRICA_WEST、UAE_CENTRAL、UAE_NORTH、または QATAR_CENTRAL 。

      データを保存する場所を定義する 設定のグループ。

      属性を非表示 属性を表示

      • name string

        データ ストアを識別する、人間が判読可能なラベル。 databases.[n].collections.[n].dataSources.[n].storeNameフィールドは、マッピング構成の一部としてこの値を参照します。 MongoDB Cloud をデータストアとして使用するには、データレイクにサーバーレスインスタンスまたはM10 以上のクラスターが必要です。

      • プロバイダー string 必須 弁別子

        値は dls:gcp です。

      • リージョン string

        Google Cloud Platformリージョン。

        値は ASIA_EAST_2、ASIA_NORTHEAST_2、ASIA_NORTHEAST_3、ASIA_SOUTH_1、ASIA_SOUTH_2、ASIA_SOUTHEAST_2、AUSTRALIA_SOUTHEAST_1、AUSTRALIA_SOUTHEAST_2、CENTRAL_US、EASTERN_ASIA_PACIFIC、EASTERN_US、EUROPE_CENTRAL_2、 EUROPE_NORTH_1、EUROPE_WEST_2、EUROPE_WEST_3、EUROPE_WEST_4、EUROPE_WEST_6、EUROPE_WEST_10、EUROPE_WEST_12、MIDDLE_EAST_CENTRAL_1、MIDDLE_EAST_CENTRAL_2、MIDDLE_EAST_WEST_1、NORTH_AMERICA_NORTHEAST_1、NORTH_AMERICA_NORTHEAST_2、NORTHEASTERN_ASIA_PACIFIC、SOUTH_AMERICA_EAST_1、SOUTH_AMERICA_WEST_1、SOUTHEASTERN_ASIA_PACIFIC、US_EAST_4、US_EAST_5、US_WEST_2、US_WEST_3、US_WEST_4、US_SOUTH_1、WESTERN_EUROPE、または WESTERN_US

      データを保存する場所を定義する 設定のグループ。

      属性を非表示 属性を表示

      • name string

        データ ストアを識別する、人間が判読可能なラベル。 databases.[n].collections.[n].dataSources.[n].storeNameフィールドは、マッピング構成の一部としてこの値を参照します。 MongoDB Cloud をデータストアとして使用するには、データレイクにサーバーレスインスタンスまたはM10 以上のクラスターが必要です。

      • プロバイダー string 必須 弁別子

        値は atlas です。

      • clusterName string

        ストアの基盤となるMongoDB Cloud クラスターの、人間が判読可能なラベル。

      • projectId string

        プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。

        最小長は 24、最大長は 24 です。形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

      • ReadConcern オブジェクト

        MongoDB Cloud クラスターの読み取り保証 (read concern)。Atlas クラスターから読み取られたデータの整合性と分離プロパティを決定します。

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

        • レベル string

          読み取られるデータの一貫性と可用性を指定する 読み取り保証 レベル

          値は、LOCAL、MAJORITY、LINEARIZABLE、SNAPSHOT、または AVAILABLE です。

          読み取り保証レベル
      • readPreference オブジェクト

        MongoDB Cloud クラスターの読み込み設定 (read preference)は、読み取りリクエストをクラスターにルーティングする方法を示します。

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

        • maxStalenessSeconds integer(int32)

          セカンダリからの読み取りの最大レプリケーションラグ、または 古さ 。

        • モード string

          読み取りリクエストをルーティングするレプリカセットメンバーを指定する 読み込み設定 (read preference)モード

          値は、primary、primaryPreferred、secondary、secondaryPreferred、または nearest です。

          読み込み設定（read preference）モード
        • tagSets array[array]

          タグセットまたはタグ仕様ドキュメントが格納されたリスト。これを指定すると、Atlas Data Lake は読み取りリクエストを、指定されたタグに関連付けられているレプリカセットノードまたはノードにルーティングします。

          読み込み設定（read preference）タグセット リスト
          tagsSets 属性を非表示にする tagsSets 属性の表示 オブジェクト

          • name string

            人間が判読できるタグのラベル。

          • 価値 string

            タグの値。

      データを保存する場所を定義する 設定のグループ。

      属性を非表示 属性を表示

      • name string

        データ ストアを識別する、人間が判読可能なラベル。 databases.[n].collections.[n].dataSources.[n].storeNameフィールドは、マッピング構成の一部としてこの値を参照します。 MongoDB Cloud をデータストアとして使用するには、データレイクにサーバーレスインスタンスまたはM10 以上のクラスターが必要です。

      • プロバイダー string 必須 弁別子

        値は http です。

      • allowInsecure ブール値

        指定された URL のスキームを検証するフラグ。 true の場合、安全でない HTTP スキームを許可し、サーバーの証明書チェーンとホスト名を検証せず、サーバーによって提示されたホスト名を持つ任意の証明書を受け入れます。 false の場合、安全な HTTPS スキームのみを許可します。

        デフォルト値はfalseです。

      • defaultFormat string

        を検索中に拡張子のないファイルを検出した場合に Atlas Data LakestoreName が想定するデフォルトの形式。省略した場合、Data Lake はファイルの数バイトを処理してファイルの種類を検出しようとします。指定された形式は、データベース.[n].collections.[n].dataSourcesオブジェクトで指定された URL にのみ適用されます。

      • urls array[string]

        データが保存される一般にアクセス可能なHTTP URL のコンマ区切りリスト。認証を必要とする URL は指定できません。

      データを保存する場所を定義する 設定のグループ。

      属性を非表示 属性を表示

      • name string

        データ ストアを識別する、人間が判読可能なラベル。 databases.[n].collections.[n].dataSources.[n].storeNameフィールドは、マッピング構成の一部としてこの値を参照します。 MongoDB Cloud をデータストアとして使用するには、データレイクにサーバーレスインスタンスまたはM10 以上のクラスターが必要です。

      • プロバイダー string 必須 弁別子

        値は azure です。

      • containerName string

        コンテナの名前を識別する、人間が判読可能なラベル。

      • delimiter string

        Delimiter.

      • prefix string

        プレフィックス。

      • public ブール値

        BLOB ストアがパブリックかどうかを示すフラグ。 true に設定すると、 MongoDB Cloud は BLOB ストアにアクセスするために構成されたAzureサービス プリンシパルを使用しません。 false に設定されている場合、構成されたAzureサービス プリンシパルには、Blob ストアにアクセスするための権限が含まれている必要があります。

        デフォルト値はfalseです。

      • リージョン string

        Microsoft Azureリージョン。

        値は US_CENTRAL、US_EAST、US_EAST_2、US_NORTH_CENTRAL、US_WEST、US_SOUTH_CENTRAL、EUROPE_NORTH、EUROPE_WEST、US_WEST_CENTRAL、US_WEST_2、US_WEST_3、CANADA_EAST、 CANADA_CENTRAL、BRAZIL_SOUTH、BRAZIL_SOUTHEAST、AUSTRALIA_CENTRAL、AUSTRALIA_CENTRAL_2、AUSTRALIA_EAST、AUSTRALIA_SOUTH_EAST、GERMANY_CENTRAL、GERMANY_NORTH_EAST、GERMANY_WEST_CENTRAL、GERMANY_NORTH、SWEDEN_CENTRAL、SWEDEN_SOUTH、SWITZERLAND_NORTH、SWITZERLAND_WEST、UK_SOUTH、UK_WEST、NORWAY_EAST、NORWAY_WEST、INDIA_CENTRAL、INDIA_SOUTH、INDIA_WEST、CHINA_EAST、CHINA_NORTH、ASIA_EAST、 JAPAN_EAST、JAPAN_WEST、ASIA_SOUTH_EAST、KOREA_CENTRAL、KOREA_SOUTH、FRANCE_CENTRAL、FRANCE_SOUTH、SOUTH_AFRICA_NORTH、SOUTH_AFRICA_WEST、UAE_CENTRAL、UAE_NORTH、または QATAR_CENTRAL 。

      • replacementDelimiter string

        区切り文字を置き換え。

      • serviceURL string

        サービスURL。

      データを保存する場所を定義する 設定のグループ。

      属性を非表示 属性を表示

      • name string

        データ ストアを識別する、人間が判読可能なラベル。 databases.[n].collections.[n].dataSources.[n].storeNameフィールドは、マッピング構成の一部としてこの値を参照します。 MongoDB Cloud をデータストアとして使用するには、データレイクにサーバーレスインスタンスまたはM10 以上のクラスターが必要です。

      • プロバイダー string 必須 弁別子

        値は gcs です。

      • バケット string

        Google Cloud Storageバケットを識別する、人間に判読可能なラベル。

      • delimiter string

        Delimiter.

      • prefix string

        プレフィックス。

      • public ブール値

        バケットがパブリックかどうかを示すフラグ。 true に設定すると、 MongoDB Cloud はバケットにアクセスするために構成されたGCPサービス アカウントを使用しません。 false に設定されている場合、設定されたGCPサービス アカウントにはバケットにアクセスするための権限が含まれている必要があります。

        デフォルト値はfalseです。

      • リージョン string

        Google Cloud Platformリージョン。

        値は ASIA_EAST_2、ASIA_NORTHEAST_2、ASIA_NORTHEAST_3、ASIA_SOUTH_1、ASIA_SOUTH_2、ASIA_SOUTHEAST_2、AUSTRALIA_SOUTHEAST_1、AUSTRALIA_SOUTHEAST_2、CENTRAL_US、EASTERN_ASIA_PACIFIC、EASTERN_US、EUROPE_CENTRAL_2、 EUROPE_NORTH_1、EUROPE_WEST_2、EUROPE_WEST_3、EUROPE_WEST_4、EUROPE_WEST_6、EUROPE_WEST_10、EUROPE_WEST_12、MIDDLE_EAST_CENTRAL_1、MIDDLE_EAST_CENTRAL_2、MIDDLE_EAST_WEST_1、NORTH_AMERICA_NORTHEAST_1、NORTH_AMERICA_NORTHEAST_2、NORTHEASTERN_ASIA_PACIFIC、SOUTH_AMERICA_EAST_1、SOUTH_AMERICA_WEST_1、SOUTHEASTERN_ASIA_PACIFIC、US_EAST_4、US_EAST_5、US_WEST_2、US_WEST_3、US_WEST_4、US_SOUTH_1、WESTERN_EUROPE、または WESTERN_US

      • replacementDelimiter string

        区切り文字を置き換え。

• 400 application/ JSON

  無効なリクエストです。

  応答属性の非表示 応答属性の表示 オブジェクト

  • validRequestDetail オブジェクト

    無効なリクエストの詳細。

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

    • フィールド array[オブジェクト]

      クライアントリクエストにおけるすべての違反を説明します。

      フィールド属性を非表示にする フィールド属性の表示 オブジェクト

      • 説明 string 必須

        リクエスト要素が禁止されている理由の説明。

      • フィールド string 必須

        リクエスト本文内のフィールドにつながるパス。

  • 詳細 string

    各タイプのエラーの原因となる特定の条件または理由について説明します。

  • エラー integer(int32) 必須

    このエラーで返された HTTP ステータス コード。

    外部ドキュメント
  • errorCode string 必須

    このエラーで返されたアプリケーション エラー コード。

  • パラメーター array[オブジェクト]

    エラーに関する詳細情報を提供するために使用されるパラメーター。
  • 理由 string

    このエラーで返されたアプリケーション エラー メッセージ。

• 401 application/ JSON

  許可されていません。

  応答属性の非表示 応答属性の表示 オブジェクト

  • validRequestDetail オブジェクト

    無効なリクエストの詳細。

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

    • フィールド array[オブジェクト]

      クライアントリクエストにおけるすべての違反を説明します。

      フィールド属性を非表示にする フィールド属性の表示 オブジェクト

      • 説明 string 必須

        リクエスト要素が禁止されている理由の説明。

      • フィールド string 必須

        リクエスト本文内のフィールドにつながるパス。

  • 詳細 string

    各タイプのエラーの原因となる特定の条件または理由について説明します。

  • エラー integer(int32) 必須

    このエラーで返された HTTP ステータス コード。

    外部ドキュメント
  • errorCode string 必須

    このエラーで返されたアプリケーション エラー コード。

  • パラメーター array[オブジェクト]

    エラーに関する詳細情報を提供するために使用されるパラメーター。
  • 理由 string

    このエラーで返されたアプリケーション エラー メッセージ。

• 403 application/ JSON

  Forbidden.

  応答属性の非表示 応答属性の表示 オブジェクト

  • validRequestDetail オブジェクト

    無効なリクエストの詳細。

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

    • フィールド array[オブジェクト]

      クライアントリクエストにおけるすべての違反を説明します。

      フィールド属性を非表示にする フィールド属性の表示 オブジェクト

      • 説明 string 必須

        リクエスト要素が禁止されている理由の説明。

      • フィールド string 必須

        リクエスト本文内のフィールドにつながるパス。

  • 詳細 string

    各タイプのエラーの原因となる特定の条件または理由について説明します。

  • エラー integer(int32) 必須

    このエラーで返された HTTP ステータス コード。

    外部ドキュメント
  • errorCode string 必須

    このエラーで返されたアプリケーション エラー コード。

  • パラメーター array[オブジェクト]

    エラーに関する詳細情報を提供するために使用されるパラメーター。
  • 理由 string

    このエラーで返されたアプリケーション エラー メッセージ。

• 404 application/ JSON

  見つかりません。

  応答属性の非表示 応答属性の表示 オブジェクト

  • validRequestDetail オブジェクト

    無効なリクエストの詳細。

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

    • フィールド array[オブジェクト]

      クライアントリクエストにおけるすべての違反を説明します。

      フィールド属性を非表示にする フィールド属性の表示 オブジェクト

      • 説明 string 必須

        リクエスト要素が禁止されている理由の説明。

      • フィールド string 必須

        リクエスト本文内のフィールドにつながるパス。

  • 詳細 string

    各タイプのエラーの原因となる特定の条件または理由について説明します。

  • エラー integer(int32) 必須

    このエラーで返された HTTP ステータス コード。

    外部ドキュメント
  • errorCode string 必須

    このエラーで返されたアプリケーション エラー コード。

  • パラメーター array[オブジェクト]

    エラーに関する詳細情報を提供するために使用されるパラメーター。
  • 理由 string

    このエラーで返されたアプリケーション エラー メッセージ。

• 500 application/ JSON

  内部サーバーエラー。

  応答属性の非表示 応答属性の表示 オブジェクト

  • validRequestDetail オブジェクト

    無効なリクエストの詳細。

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

    • フィールド array[オブジェクト]

      クライアントリクエストにおけるすべての違反を説明します。

      フィールド属性を非表示にする フィールド属性の表示 オブジェクト

      • 説明 string 必須

        リクエスト要素が禁止されている理由の説明。

      • フィールド string 必須

        リクエスト本文内のフィールドにつながるパス。

  • 詳細 string

    各タイプのエラーの原因となる特定の条件または理由について説明します。

  • エラー integer(int32) 必須

    このエラーで返された HTTP ステータス コード。

    外部ドキュメント
  • errorCode string 必須

    このエラーで返されたアプリケーション エラー コード。

  • パラメーター array[オブジェクト]

    エラーに関する詳細情報を提供するために使用されるパラメーター。
  • 理由 string

    このエラーで返されたアプリケーション エラー メッセージ。