Atlas API FlexSnapshots ダウンロードFlexBackup

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

パブリックプレビュー: でフィードバックを提供してください: 指定されたフレキシブルなクラスターのスナップショットを 1 つ要求します。

このリソースは、スナップショットをダウンロードするために使用できる snapshotURL を返します。この snapshotURL は、リクエストを行った後 4 時間アクティブのままになります。このリソースを使用するには、リクエスト元のAPIキーにプロジェクトオーナーのロールが必要です。

1このコマンドは自動生成され、:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Flex-スナップショット/操作/ダウンロードFlexBackup。

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

構文

コマンド構文

atlas api flexSnapshots downloadFlexBackup [options]

オプション

名前	タイプ	必須	説明
-- 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	ダウンロードFlexBackup のヘルプ
--name	string	true	フレキシブルなクラスターを識別する、人間が判読できるラベル。
--出力	string	false	優先API形式は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。
-- output-file	string	false	API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。
--pretty		false	レスポンス本体を <aクエリを実行するかどうかを示すフラグtarget ` ` Sharding</a>
--version	string	false	API 呼び出し [options: "2024-11-13"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値をプロファイルします。この値のデフォルトは "2024-11-13"

継承されたオプション

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