AIエージェントの場合: ドキュメントインデックスはhttps://www.mongodb.com/ja-jp/docs/llms.txt で利用可能です。任意のURLパスに .md を追加することで、すべてのページのマークダウン バージョンが利用できます。
Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
MongoDB Branding Shape
Click here >
Docs Menu

atlas api organizations listOrgs

リクエスト元のサービス アカウントまたは API キーがアクセスできるすべての組織を返します。

atlas api サブコマンドはMongoDB Atlas Admin APIから自動的に生成され、Admin APIの完全なカバレッジを提供します。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントとなる接続されたデバイスのドキュメント リンクから確認できます。

このコマンドは自動生成され、1:1 と Atlas API エンドポイントとなる接続されたデバイス https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgs. に対応しています。

詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。

コマンド構文
atlas api organizations listOrgs [options]
名前
タイプ
必須
説明

-- envelope

envelope

false

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

-h, --help

false

listOrgs のヘルプ

--includeCount

totalCount

false

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

--itemsPerPage

整数

false

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

--name

string

false

返却するリストをフィルタリングするために使用される、人間が判読可能な組織のラベル。指定された名前で始まる組織を、大文字と小文字を区別せずに検索します。

-o, --output

string

false

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

-- outputFile

string

false

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

--pageNum

整数

false

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

--pretty

false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

--version

string

false

Atlas APIエンドポイントを呼び出すときに使用するAPIバージョン [options: "2023-01-01"] 。ユーザーによって設定されない場合は、デフォルトで最新バージョンになるか、プロファイルの api_version 構成値 (設定されている場合)になります。この値のデフォルトは "2023-01-01" です。

名前
タイプ
必須
説明

-P, --profile

string

false

構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。