Atlas バックアップのエクスポート ジョブ作成
M10 以上のAtlasクラスターの 1 つのバックアップ スナップショットを既存のAmazon Web Services S3 バケットにエクスポートします。
このコマンドを使用するには、プロジェクト オーナーのユーザー アカウントまたは API キーで認証する必要があります。
構文
コマンド構文
atlas backups exports jobs create [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--bucketId | string | true | Atlas がバケットに割り当てる一意の識別子。 |
--clusterName | string | true | クラスターの名前。 詳しくは、 https://docub.mongodb.org/core/create-cluster-api を参照してください。 |
--customData | key=value | false | .complete という名前のメタデータ ファイルに含めるカスタム データ エクスポート ジョブが完了したときに Atlas がバケットにアップロードする形式。 カスタム データは、キーと値のペアとして指定できます。 |
-h, --help | false | 作成用ヘルプ | |
-o, --output | string | false | 出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。 |
--projectId | string | false | 使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
--snapshotId | string | true | スナップショットの一意の識別子。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
出力
コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
Export job '<Id>' created in a bucket with ID '<ExportBucketId>'.
例
# The following command exports one backup snapshot of the ExampleCluster cluster to an existing AWS S3 bucket: atlas backup export jobs create --clusterName ExampleCluster --bucketId 62c569f85b7a381c093cc539 --snapshotId 62c808ceeb4e021d850dfe1b --customData name=test,info=test