パブリック プレビュー:フィードバックを提供してください : 指定されたプロジェクトのIP アクセス リストから 1 件のアクセス リスト エントリを返します。
パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なフィードバックを提供し、現在パブリック プレビュー段階です（フィードバック 930808-Atlas-cli ）。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。
プロジェクトのIP アクセス リストの各エントリには、1 つのIPアドレスまたは 1 つの CIDR 表記のIPアドレス ブロックが含まれます。MongoDB Cloud は、プロジェクトのIP アクセス リストのエントリからのみクラスタへのクライアント接続を許可します。このリソースを使用するには、リクエスト元の サービス アカウント またはAPIキーに プロジェクト読み取り専用 ロールまたは プロジェクト Charts 管理者 ロールが必要です。このリソースはホワイトリストリソースを置き換えます。MongoDB Cloud は 7 月 2021 にホワイトリストを削除しました。この新しいリソースを使用するには、アプリケーションを更新してください。このエンドポイント（/groups/{GROUP- ID}/accessList）は、プロジェクトのIPアクセス リストを管理します。MongoDB Cloud 組織のアクセス リストは管理されません。これらはプログラマティックAPIキー エンドポイント（/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-getprojectiplist 。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api projectIpAccessList getProjectIpList [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--entryValue | / | true | プロジェクトのIP アクセス リストから返却したいアクセス リスト エントリ。この値では、1 つのAmazon Web Servicesセキュリティグループ ID、1 つのIPアドレス、または 1 つのアドレスの CIDR ブロックのいずれかを使用できます。 サブネット マスクを使用する CIDR ブロックの場合は、スラッシュ（/）をURLエンコードされた値（ |
-- envelope | envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。 |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
-h, --help | false | getProjectIpList のヘルプ | |
-o, --output | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- outputFile | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--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 getProjectIpList --version 2023-01-01 --entryValue 10.0.0.0/16 --groupId [your-project-id]