atlas api atlasSearch getAtlasSearchIndex

string

true

1 つ以上の Atlas Search インデックスを持つコレクションを含むクラスターの名前。

envelope

false

アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

string

true

プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

false

getAtlasSearchIndex のヘルプ

string

true

アプリケーション検索 [インデックス] を識別する一意の 桁の24 16 進数文字列（ https://docub.mongodb.org/core/index-defineds-fts ）。[取得] エンドポイントを使用して、コレクションAPIのすべてのアプリケーション検索インデックスを取得します（https://mongodb.com/ja-jp/docs/atlas/reference/api/fts-indexes-get-all/）エンドポイントを使用して、すべての ID を検索しますアプリケーション検索 インデックス。

string

false

優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。

string

false

API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。

false

レスポンス本体を <aクエリを実行するかどうかを示すフラグtarget ` ` Sharding</a>

string

false

API 呼び出し [options: "2024-05-30"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2024-05-30"