パブリック プレビュー: にフィードバックを提供してください: 指定されたプロジェクト内の 1 つのクラスターのレガシーバックアップスナップショットを 1 つ返します。
このリソースを使用するには、リクエスト元のAPIキーにプロジェクトの読み取り専用ロールが必要です。23 3 月 2020 以降、すべての新しいクラスターはクラウドバックアップのみを使用できます。4.2 にアップグレードすると、バックアップシステムが現在レガシーバックアップに設定されている場合は、クラウドバックアップにアップグレードされます。このアップグレード後も、既存のレガシーバックアップスナップショットはすべて引き続き利用できますが、保持ポリシーに従い、時間の経過とともに期限が切れます。バックアップポリシーがデフォルトのスケジュールにリセットされます。レガシーバックアップでカスタムバックアップポリシーを設定していた場合は、 クラウドバックアップに関するドキュメント に記載されている手順に従ってポリシーを再作成する必要があります。
1このコマンドは自動生成され、:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Legacy- と対応しますBackup/操作/getLegacySnapshot
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api legacyBackup getLegacySnapshot [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--clusterName | string | true | クラスターを識別する人間が判読できるラベル。 |
-- envelope | envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。 |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
-h, --help | false | getLegacySnapshot のヘルプ | |
--出力 | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- output-file | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--pretty | false | ||
--snapshotId | string | true | 目的のスナップショットを識別するユニークな 24 桁の 16 進数の文字列。 |
--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 を参照してください。 |
例
以下の コマンドを実行します。
atlas api legacyBackup getLegacySnapshot --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --snapshotId [snapshotId]