Docs Menu
Docs Home
/ /
Atlas CLI
/ / / /

Atlas サーバーレスバックアップのスナップショットの説明

項目一覧

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

プロジェクトの指定されたスナップショットの詳細を返します。

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

コマンド構文
atlas serverless backups snapshots describe [options]
名前
タイプ
必須
説明

--clusterName

string

true

クラスターの名前。 詳しくは、 https://docub.mongodb.org/core/create-cluster-api を参照してください。

-h, --help

false

説明用のヘルプ

-o, --output

string

false

出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。

--projectId

string

false

使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。

--snapshotId

string

true

スナップショットの一意の識別子。

名前
タイプ
必須
説明

-P, --profile

string

false

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

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

ID SNAPSHOT TYPE EXPIRES AT
<Id> <SnapshotType> <ExpiresAt>
# Return the details for the backup snapshot with the ID 5f4007f327a3bd7b6f4103c5 for the instance named myDemo:
atlas serverless backups snapshots describe --snapshotId 5f4007f327a3bd7b6f4103c5 --clusterName myDemo

戻る

スナップショット