Atlas API legacyBackup createLegacyBackupRestoreJob

Atlas Administration APIでコマンドを実行中ための Atlas CLI サポートはプレビュー段階です。機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。詳しくは、プレビュー機能を参照してください。

パブリックプレビュー:フィードバックを提供してください : 指定されたプロジェクト内の 1 つのクラスターのレガシーバックアップを 1 件復元します。

パブリックプレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なフィードバックを提供し、現在パブリックプレビュー段階です（フィードバック 930808-Atlas-cli ）。管理API機能には独自のリリースライフサイクルがあり、提供されているAPIエンドポイントのドキュメントリンクから確認できます。

このリソースを使用するには、リクエスト元のサービスアカウントまたはAPIキーにプロジェクトオーナーのロールが必要です。23 3 月 2020 以降、すべての新しいクラスターはクラウドバックアップのみを使用できます。4.2 にアップグレードすると、バックアップシステムが現在レガシーバックアップに設定されている場合は、クラウドバックアップにアップグレードされます。このアップグレード後も、既存のレガシーバックアップスナップショットはすべて引き続き利用できますが、保持ポリシーに従い、時間の経過とともに期限が切れます。バックアップポリシーがデフォルトのスケジュールにリセットされます。レガシーバックアップでカスタムバックアップポリシーを設定していた場合は、クラウドバックアップに関するドキュメントに記載されている手順に従ってポリシーを再作成する必要があります。このエンドポイントは、シャーディングされたクラスターのチェックポイント復元ジョブの作成、またはクエリ可能なバックアップショットの復元ジョブの作成をサポートしていません。リクエスト本文に AutoMATED_RESTORE の delivery.methodName を指定して自動復元ジョブを作成すると、 MongoDB Cloud により、復元前にターゲットクラスター上の既存のデータがすべて削除されます。

このコマンドは自動生成され、1:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-createlegacybackuprestorejob.

詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。

構文

コマンド構文

atlas api legacyBackup createLegacyBackupRestoreJob [options]

オプション

名前	タイプ	必須	説明
--clusterName	string	true	返却対象のスナップショットを持つクラスターを識別する、人間が判読可能なラベル。
-- envelope	envelope	false	アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータスパラメータを追加します。
--file	string	false	APIリクエストファイルへのパス。代わりに標準入力を使用するには、を空のままにします。どちらか一方を指定する必要がありますが、両方を指定することはできません。
--groupId	string	true	プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
-h, --help		false	createLegacyBackupRestoreJob のヘルプ
-o, --output	string	false	優先API形式は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。
-- outputFile	string	false	API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。
--pretty		false	レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
--version	string	false	API 呼び出し [options: "2023-01-01"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値をプロファイルします。この値のデフォルトは "2023-01-01"

継承されたオプション

名前	タイプ	必須	説明
-P, --profile	string	false	構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。