Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

Atlas clusters OnlineAr Archives describe

項目一覧

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

クラスターの指定されたオンラインアーカイブの詳細を返します。

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

コマンド構文
atlas clusters onlineArchives describe <archiveId> [options]
名前
タイプ
必須
説明
archiveId
string
true
検索対象のオンライン アーカイブの一意の識別子です。
名前
タイプ
必須
説明
--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。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。
名前
タイプ
必須
説明
-P, --profile
string
false
構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。

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

ID CLUSTER DATABASE COLLECTION STATE
<Id> <ClusterName> <DbName> <CollName> <State>
# Return the JSON-formatted details for the online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster:
atlas clusters onlineArchives describe 5f189832e26ec075e10c32d3 --clusterName myCluster --output json

戻る

削除