Atlas クラスター検索インデックス リスト
クラスターのすべての Atlas Search インデックスを一覧表示します。
このコマンドを使用するには、ユーザー アカウントまたは、プロジェクト データアクセス読み取り/書込みロールを持つ API キーで認証する必要があります。
構文
コマンド構文
atlas clusters search indexes list [options]
オプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
--clusterName | string | true | クラスターの名前。 詳しくは、 https://docub.mongodb.org/core/create-cluster-api を参照してください。 |
--collection | string | true | コレクション名。 |
--db | string | true | データベースの名前。 |
-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 NAME DATABASE COLLECTION TYPE <IndexID> <Name> <Database> <CollectionName> <Type>
例
# Return the JSON-formatted list of Atlas search indexes on the sample_mflix.movies database in the cluster named myCluster: atlas clusters search indexes list --clusterName myCluster --db sample_mflix --collection movies --output json