Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

Atlas clusters connectionStrings describe

項目一覧

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

指定したクラスターの SRV 接続文字列を返します。

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

コマンド構文
atlas clusters connectionStrings describe <clusterName> [options]
名前
タイプ
必須
説明
clusterName
string
true
接続文字列を取得する Atlas クラスターの名前。
名前
タイプ
必須
説明
-h, --help
false
説明用のヘルプ
-o, --output
string
false
出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。
--projectId
string
false
使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。
--type
string
false
接続文字列のタイプ。 「private」を指定すると、このオプションはネットワークピアリングエンドポイントの接続文字列を検索します。 「privateEndpoint」を指定すると、このオプションはプライベートエンドポイント用のシャード最適化された接続文字列を検索します。 この値のデフォルトは「standard」です。
名前
タイプ
必須
説明
-P, --profile
string
false
構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルについては、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。
# Return the JSON-formatted connection strings for the cluster named myCluster:
atlas clusters connectionStrings describe myCluster --output json

戻る

接続文字列