Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

Atlas API cloudBackups createBackupExportJob

実験的な : クラウドバックアップを使用して専用の Atlas クラスターの 1 つのバックアップスナップショットをエクスポート バケットにエクスポートします。

このリソースを使用するには、リクエスト元のAPIキーに Project Atlas の管理者ロールが必要です。このコマンドは、OpsID: 'createBackupExportJob' を使用してエンドポイントを呼び出します。フラグ、--ファイルの形式、および例の詳細については、 https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Cloud-Backups/ 操作/createBackupExportJob

コマンド構文
atlas api cloudBackups createBackupExportJob [options]
名前
タイプ
必須
説明

--clusterName

string

true

クラスターを識別する、人間が判読できるラベル

-- envelope

false

アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ

--file

string

false

APIリクエストの内容を含むファイルへのパス

--groupId

string

true

プロジェクトを識別する一意の 24 桁の 16 進数の文字列

-h, --help

false

createBackupExportJob のヘルプ

--出力

string

false

優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。

-- output-file

string

false

API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ(例: gzip)で、コマンドがパイプライン化されていない場合(例: Atlas コマンド >out.zip)に必要です。

--version

string

false

API 呼び出し [options: "2023-01-01"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2023-01-01"

-w, --watch

false

コマンドの実行が完了するまで監視するか、監視がタイムアウトするまで監視するかを示すフラグ。

--watchTimeout

整数

false

監視がタイムアウトするまでの時間(秒単位)。 監視がタイムアウトすると、CLI は コマンドの監視を終了します。

名前
タイプ
必須
説明

-P, --profile

string

false

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

戻る

cancelBackupRestoreJob

項目一覧