指定された M2 または M5 クラスターを復元します。
atlas api サブコマンドはMongoDB Atlas Admin APIから自動的に生成され、Admin APIの完全なカバレッジを提供します。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。
MongoDB Cloud では、復元のターゲット クラスターにできるクラスターが限定されています。ターゲット クラスターは、保管時の暗号化を使用したり、スナップショットと異なる MongoDB のメジャーリリース バージョンを実行したり、復元中にクライアントリクエストを受信することができません。MongoDB Cloud は、復元操作の前に、ターゲット クラスター上の既存のデータをすべて削除します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに Project Owner ロールが必要です。
このエンドポイントは、 createCluster エンドポイントを使用して作成された Flex クラスター、または 1 月 2026 まで Flex クラスターに移行された以前の M2/M5 クラスターでも使用できます。その後、このエンドポイントは廃止されます。代わりに createFlexBackupRestoreJob エンドポイントを使用してください。
1このコマンドは自動生成され、:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2 /操作/ operation-creategroupclusterbackuptenantrestore
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api sharedTierRestoreJobs createBackupTenantRestore [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 | createBackuptenantRestore のヘルプ | |
-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://dochub.mongodb.org/core/atlas-cli-save-connection-settings. を参照してください。 |