指定されたプロジェクトの IP アクセス リストから 1 件のアクセス リスト エントリを削除します。
atlas api サブコマンドはMongoDB Atlas Admin APIから自動的に生成され、Admin APIの完全なカバレッジを提供します。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントとなる接続されたデバイスのドキュメント リンクから確認できます。
プロジェクトの IP アクセス リストの各エントリには、1 つの IP アドレス、1 つの CIDR で記述された IP アドレスのブロック、または 1 つの Amazon Web Services セキュリティ グループ ID が含まれています。MongoDB クラウドは、プロジェクトの IP アクセス リストのエントリからのクラスターへのクライアント接続のみを許可します。このリソースはホワイトリスト リソースを置き換えます。MongoDB クラウドは 2021 年 7 月にホワイトリストを削除しました。この新しいリソースを使用するには、アプリケーションを更新してください。/groups/{GROUP-ID}/accessList エンドポイントはデータベース IP アクセス リストを管理します。このエンドポイントとなる接続されたデバイスは、MongoDB クラウド組織のアクセス リストを管理する 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-deletegroupaccesslistentry. と対応しています。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api projectIpAccessList deleteAccessListEntry [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--entryValue | / | true | プロジェクトのIP アクセス リストから除くアクセス リスト エントリ。この値では、1 つの AWS グループ 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 | deleteAccessListEntry のヘルプ | |
-o, --output | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- outputFile | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ(例: gzip)で、コマンドがパイプライン化されていない場合(例: Atlas コマンド >out.zip)に必要です。 |
--pretty | false | レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。 | |
--version | string | false | Atlas API エンドポイントを呼び出すときに使用する API バージョン [オプション: "2023-01-01"]。ユーザーが設定しない場合は、最新バージョンまたはプロファイルの api_version 構成値が設定されている場合はその値がデフォルトになります。この値のデフォルトは "2023-01-01" です。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
例
atlas api projectIpAccessList deleteAccessListEntry --version 2023-01-01 --entryValue 10.0.0.0/16 --groupId [your-project-id]