AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。
Docs Menu

atlas API 組織 getOrgGroups

指定した組織内の複数のプロジェクトを返します。

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

各組織は複数のプロジェクトを持つことができます。プロジェクトを使用して、次の操作を行います。

開発環境、テスト環境、本番環境などの異なる環境を相互に分離します。

異なる MongoDB Cloud ユーザーまたはチームを異なる環境に関連付けるか、異なる環境の MongoDB Cloud ユーザーに異なる権限を付与します。

個別のクラスターセキュリティ構成を維持します。

さまざまなアラート設定を作成します。

このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに組織メンバーのロールが必要です。

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

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

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

-- envelope

envelope

false

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

-h, --help

false

getOrgGroups のヘルプ

--includeCount

false

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

--itemsPerPage

整数

false

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

--name

string

false

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

--orgId

string

true

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

-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

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

名前
タイプ
必須
説明

-P, --profile

string

false

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

atlas api organizations getOrgGroups --version 2023-01-01 --orgId 4888442a3354817a7320eb61