Atlas 配置検索インデックスは説明します
指定された配置の検索インデックスを記述します。
構文
コマンド構文
atlas deployments search indexes describe [indexId] [options]
Arguments
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
indexId | string | false | インデックスの ID。 |
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--deploymentName | string | false | 配置名。 |
-h, --help | false | 説明用のヘルプ | |
-o, --output | string | false | 出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。 |
--password | string | false | ユーザーのパスワード。 |
--projectId | string | false | 使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
--type | string | false | 配置のタイプ。 有効な値は Atlas または Local です。 |
--username | string | false | MongoDB への認証に使用するユーザー名。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルについては、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
出力
コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
ID NAME DATABASE COLLECTION STATUS TYPE <IndexID> <Name> <Database> <CollectionName> <Status> <Type>