実験的な : 指定されたプロジェクトに 1 つの Atlas Searchインデックスを返します。
このインデックスは、データベース、コレクション、および名前を使用して識別します。Atlas Searchインデックスには、インデックス付きフィールドと、インデックスの作成に使用されたアナライザが含まれています。このリソースを使用するには、リクエスト元のAPIキーにプロジェクトのデータアクセスに関する読み取りおよび書込みロールが必要です。このコマンドは、OpsID: 'getAtlasSearchIndexByName' を使用してエンドポイントを呼び出しています。フラグ、--ファイルの形式、および例の詳細については、次を参照してください: https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Atlas-Search/ 操作/getAtlasSearchIndexByName
構文
atlas api atlasSearch getAtlasSearchIndexByName [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--clusterName | string | true | 1 つ以上の Atlas Search インデックスを持つコレクションを含むクラスターの名前 |
--collectionName | string | true | 1 つ以上の Atlas Search インデックスを含むコレクションの名前 |
--databaseName | string | true | 1 つ以上の Atlas Search インデックスを持つコレクションを含むデータベースを識別するラベル |
-- envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ | |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数の文字列 |
-h, --help | false | getAtlasSearchIndexByName のヘルプ | |
--indexName | string | true | 返す対象の Atlas Searchインデックスの名前 |
--出力 | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- output-file | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--pretty | false | レスポンス本体を pretty-print形式にするかどうかを示すフラグ | |
--version | string | false | API 呼び出し [options: "2024-05-30"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2024-05-30" |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |