atlas api clusters listClusters

envelope

false

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

string

true

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

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

false

listClusters のヘルプ

false

レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。

false

バックアップを保持するクラスターを返すかどうかを示すフラグ。

整数

false

レスポンスが返す 1 ページあたりのアイテムの数。

string

false

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

string

false

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

整数

false

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

false

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

string

false

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