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

atlas api projectIpAccessList listAccessListEntries

指定されたプロジェクトの IP アクセス リストからすべてのアクセス リスト エントリを返します。

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

プロジェクトのIP アクセス リストの各エントリには、1 つのIPアドレスまたは 1 つの CIDR 表記のIPアドレス ブロックが含まれます。MongoDB Cloud は、プロジェクトのIP アクセス リストのエントリからのみクラスタへのクライアント接続を許可します。このリソースを使用するには、リクエスト元の サービス アカウント またはAPIキーに プロジェクト読み取り専用 ロールまたは プロジェクト Charts 管理者 ロールが必要です。このリソースはホワイトリストリソースを置き換えます。MongoDB Cloud は 7 月 2021 にホワイトリストを削除しました。この新しいリソースを使用するには、アプリケーションを更新してください。/groups/{GROUP- ID}/accessList エンドポイントは、データベースIP アクセス リストを管理します。このエンドポイントは、 MongoDB Cloud 組織のアクセス リストを管理する orgs/{ORG- ID}/apiKeys/{API-KEY- ID }/accesslist エンドポイントとは異なります。

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

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

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

-- envelope

envelope

false

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

--groupId

string

true

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

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

-h, --help

false

listAccessListEntries のヘルプ

--includeCount

false

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

--itemsPerPage

整数

false

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

-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 projectIpAccessList listAccessListEntries --version 2023-01-01 --groupId [your-project-id]