Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

Atlas バックアップ スナップショット リスト

項目一覧

  • 構文
  • Arguments
  • オプション
  • 継承されたオプション
  • 出力

プロジェクトとクラスターのすべてのクラウドバックアップ スナップショットを返します。

このコマンドを使用するには、ユーザーアカウントまたはプロジェクト読み取り専用ロールの API キーで認証する必要があります。

コマンド構文
atlas backups snapshots list <clusterName> [options]
名前
タイプ
必須
説明
clusterName
string
true
取得対象のスナップショットを含む Atlas クラスターの名前。
名前
タイプ
必須
説明
-h, --help
false
リスト用のヘルプ
--limit
整数
false
結果ページあたりの項目数。最大 500 まで。 500 を超える結果がある場合は、結果ページを変更するために --page オプションを指定します。 この値のデフォルトは 100 です。
--omitCount
false
JSON 応答が JSON 応答内の項目の総数( totalCount)を返すかどうかを示すフラグ。
-o, --output
string
false
出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。
--page
整数
false
結果のページを指定するページ番号。 この値のデフォルトは 1 です。
--projectId
string
false
使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。
名前
タイプ
必須
説明
-P, --profile
string
false
構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルについては、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。

コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。

ID TYPE STATUS CREATED AT EXPIRES AT
<Id> <SnapshotType> <Status> <CreatedAt> <ExpiresAt>
# Return a JSON-formatted list of snapshots for the cluster named myDemo
atlas backups snapshots list myDemo --output json

戻る

describe