AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。
Docs Menu

クラウドバックアップ スナップショットをオブジェクトストレージへエクスポート

注意

この機能は、 無料クラスターと Flex クラスターでは使用できません。使用できない機能の詳細については、Atlas 無料クラスターの制限 を参照してください。

Atlas を使用すると、クラウドバックアップ スナップショットをオブジェクトストレージサービスにエクスポートできます。

エクスポートされたスナップショットを Atlas クラスターに復元する方法については、「Atlas にアーカイブされたスナップショットをインポートする」を参照してください。

自動バックアップ ポリシーとスケジュールを管理する方法については、「バックアップ ポリシーの管理」を参照してください。

Atlas は現在、次のオブジェクトストレージサービスをサポートしています。

  • Amazon Web Services S3バケット

  • Azure BLOB ストレージ

  • Google Cloud ストレージバケット

さらに、Atlas は PrivateLink を使用したAWS S3 バケットへのスナップショットのエクスポートをサポートしています。

個々のスナップショットを手動でエクスポートすることも、スナップショットを自動的にエクスポートするためのエクスポート ポリシーを設定することもできます。オブジェクト ストレージ サービスに固有の手順については、クラウドプロバイダーのエクスポート ページを参照してください。

自動エクスポートを設定するには、クラウドバックアップの予定にエクスポートポリシーを追加し、その頻度タイプを dailyweeklymonthly、または yearly に設定します。同じ頻度タイプの バックアップポリシー項目 がスナップショットを作成すると、Atlas はそのスナップショットを指定したオブジェクトストアにエクスポートします。

Atlas は、エクスポート用に新しい オブジェクトストア を追加したとき、およびエクスポートを開始したときに、オブジェクトストア上の /exported_snapshots/.permissioncheck パスに空のファイルをアップロードします。エクスポートが進むにつれて、オブジェクトストレージサービスに部分的な結果が表示される場合があります。

Atlas は、 Time to Live の設定に関係なく、ドキュメントをスナップショットで保持します。これらのドキュメントには、 Time to Live の期限を過ぎたスナップショットからアクセスできます。

スナップショットのエクスポート料金の詳細については、スナップショットのエクスポート コストを参照してください。

各クラウドバックアップ スナップショットエクスポート ジョブは、スナップショット データを gzip 圧縮された拡張 JSON v2ドキュメントとしてオブジェクト ストアにアップロードします。これらのファイルは特定の順序でアップロードされません。各ファイルには、スナップショット内の単一のコレクションからのドキュメントのチャンクが含まれています。シャーディングされたクラスターの場合、Atlas はレプリカセット (シャード)ごとに別々のエクスポート ジョブを作成し、アップロードされたファイルのパスにレプリカセット名を指定します。

重要

エクスポートが進むにつれて、オブジェクトストレージサービスに部分的な結果が表示される場合があります。 エクスポート ジョブが失敗した場合:

  • Atlas は自動的にエクスポートを再試行しません。

  • Atlas はオブジェクトストア内の部分的なデータを削除しません。

Atlas は、各データファイルをオブジェクトストアの次のパスにアップロードします。

/exported_snapshots/<orgName>/<projectName>/<clusterName>/<initiationDateOfSnapshot>/<timestamp>/<dbName>/<collectionName>/<shardName>.<increment>.json.gz

Atlas は、パス内の各プレースホルダーを次の値で置き換えます。

<orgName>

Atlas 組織の名前。

<projectName>

Atlas プロジェクトの名前。

<clusterName>

Atlas クラスターの名前。

<initiationDateOfSnapshot>

スナップショットが作成された日付。

<timestamp>

エクスポート ジョブが作成されたときのタイムスタンプ。

<dbName>

Atlas クラスター内のデータベースの名前。

<collectionName>

Atlas コレクションの名前。

<shardName>

<increment>

チャンクがアップロードされるにつれて増加するカウント。0 から始まります。

Atlas がスナップショット データのオブジェクト保存へのエクスポートを完了すると、Atlas は各コレクションに対して .complete という名前のメタデータ ファイルと metadata.json という名前のメタデータ ファイルをアップロードします。

エクスポートジョブとエクスポートされたスナップショットに関する情報を含むメタデータファイルをエクスポートします。

スナップショットのエクスポート ジョブの各コレクションについて、Atlas は .complete という名前のメタデータ ファイルをオブジェクトストアの次のパスにアップロードします。

/exported_snapshots/<orgUUID>/<projectUUID>/<clusterName>/<initiationDateOfSnapshot>/<timestamp>/

注意

デフォルトでは、Atlas はメタデータ ファイルのパスに組織 UUID とプロジェクト UUID を使用します。UUID の代わりに組織名とプロジェクト名を使用するには、API 経由で useOrgAndGroupNamesInExportPrefix フラグを true に設定します。Atlas はスペースをアンダースコア(_)に置き換え、特別な処理を必要とする可能性のある文字と、パス内の組織名とプロジェクト名に避けるべき文字を削除します。

.complete メタデータ ファイルは JSON 形式で、次のフィールドが含まれています。

リクエスト ボディ フィールド
説明

orgId

Atlas 組織を識別する一意な 24 桁の 16 進数の文字列。

orgName

Atlas 組織の名前。

groupId

Atlas 組織内のプロジェクトを識別する一意な 24 桁の 16 進数の文字列。

groupName

Atlas プロジェクトの名前。

clusterUniqueId

Atlas クラスターを識別する一意な 24 桁の 16 進数の文字列。

clusterName

Atlas プロジェクトの名前。

snapshotInitiationDate

スナップショットが作成された日付。

totalFiles

オブジェクトストアにアップロードされたファイルの合計数。

labels

スナップショットがエクスポートされたクラスターのラベル。

customData

エクスポート ジョブの作成時に指定したカスタム データ(存在する場合)。

{
"orgId": "60512d6f65e4047fe0842095",
"orgName": "org1",
"groupId": "60512dac65e4047fe084220f",
"groupName": "group1",
"clusterUniqueId": "60512dac65e4047fe0842212",
"clusterName": "cluster0",
"snapshotInitiationDate": "2020-04-03T05:50:29.321Z"
"totalFiles": 23,
"labels": [
{
"key": "key1",
"value": "xyz"
},
{
"key": "key2",
"value": "xyzuio"
}
],
"customData": [
{
"key": "key1",
"value": "xyz"
},
{
"key": "key2",
"value": "xyzuio"
}
]
}

インデックスやオプションなど、エクスポートされたコレクションに関する情報を含むエクスポートされたメタデータ ファイル。

スナップショットのエクスポート ジョブの各コレクションについて、Atlas は metadata.json という名前のメタデータ ファイルをオブジェクトストアの次のパスにアップロードします。

/exported_snapshots/<orgUUID>/<projectUUID>/<clusterName>/<initiationDateOfSnapshot>/<timestamp>/<dbName>/<collectionName>/metadata.json

注意

デフォルトでは、Atlas はメタデータ ファイルのパスに組織 UUID とプロジェクト UUID を使用します。UUID の代わりに組織名とプロジェクト名を使用するには、API 経由で useOrgAndGroupNamesInExportPrefix フラグを true に設定します。Atlas はスペースをアンダースコア(_)に置き換え、特別な処理を必要とする可能性のある文字と、パス内の組織名とプロジェクト名に避けるべき文字を削除します。

メタデータ ファイルは JSON 形式で、次のフィールドが含まれています。

リクエスト ボディ フィールド
説明

collectionName

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

indexes

db.collection.getIndexes コマンドによって返される形式での、コレクション上のすべてのインデックスのリスト。

options

コレクションに定義されている構成オプション。オプションの詳細については、「db.createCollection()」コマンドを参照してください。

type

(任意)コレクションのタイプ。 このフィールドは時系列コレクションでのみサポートされ、値は timeseries です。 標準コレクションでは、このフィールドを設定されていないままにします。

Atlas は view タイプのコレクションのエクスポートをサポートしていません。

uuid

コレクションのUUID。UUID の詳細については、「UUID」を参照してください。

{
"options":{
"viewOn":"othercol",
"pipeline":[{"$project":{"namez":"$name"}}]
},
"indexes":[],
"collectionName":"viewcol",
"type":"view"
}
{
"options":{
"timeseries":{
"timeField":"timestamp",
"granularity":"seconds",
"bucketMaxSpanSeconds":{"$numberInt":"3600"}
}
},
"indexes":[],
"collectionName":"timeseriescol",
"type":"timeseries"
}
{
"indexes": [
{
"v":{"$numberInt":"2"},
"key":{
"_id":{"$numberInt":"1"}
},
"name":"_id_"
}
],
"uuid":"342c40a937c34c478bab03de8ce44f3e",
"collectionName":"somecol"
}

次のアクションは実行できません。

  • スナップショットごとに複数のアクティブなエクスポートがある。

  • ビューコレクション 、またはシステムコレクションをエクスポートします。ただし、 <database>.system.jsコレクションは除きます。

  • IP制限付き保管時の暗号化が有効になっている Atlasプロジェクト内のクラスターからスナップショットをエクスポートします。

  • Azure または Google Cloud Platform クラスターのプライベートエンドポイントを介したスナップショットのエクスポート (プライベートエクスポート)。

  • Atlas でクラウドバックアップのエクスポート予定を作成または管理するか、クラウドバックアップのエクスポートバケットを構成するには、プロジェクトに対してProject Backup ManagerまたはProject Ownerが必要です。

  • クラウドバックアップのエクスポートジョブを作成または管理するには、プロジェクトに対するProject Backup Export Operator またはProject Owner アクセス権が必要です。

  • クラウド バックアップ オブジェクト ストレージ プライベートエンドポイントを作成または管理するには、プロジェクトへの Project Owner アクセスが必要です。

クラウドバックアップ スナップショットをエクスポートする手順は、オブジェクトストレージ サービスによって異なります。Atlas アクセスを設定し、エクスポート バケットを構成し、スナップショットをエクスポートするには、クラウド プロバイダーのページを参照してください。

PrivateLink を介してを含む、Amazon Web Services S3 バケットへのスナップショットのエクスポート。

Amazon Web Services S3

スナップショットを Azure Blob ストレージ コンテナにエクスポートします。

Azure BLOB ストレージ

スナップショットを Google Cloud Platform ストレージ バケットにエクスポートします。

Google Cloud PlatformGoogle Cloud Platformストレージ