从指定项目的 IP 访问列表中删除一个访问列表条目。
atlas api 子命令是从 MongoDB Atlas Admin API 自动生成的,并提供对 Admin API 的全面覆盖。Admin API功能有自己的发布生命周期,您可以通过提供的API终结点文档链接进行检查。
项目 IP 访问列表中的每个条目都包含一个 IP 地址、一个 CIDR 表示的 IP 地址区块或一个 AWS 安全群组 ID(group ID)。MongoDB Cloud 仅允许客户端从项目 IP 访问列表中的条目连接到集群。此资源将替换白名单资源。MongoDB Cloud 于 2021 年 7 月删除了白名单。更新您的应用程序以使用此新资源。/groups/{GROUP-ID}/accessList 终结点管理数据库 IP 访问列表。此终结点与 orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist 终结点不同,后者管理 MongoDB 云组织的访问列表。
此命令是自动生成的,对应 1:1 和Atlas API终结点 https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupaccesslistentry.
有关更多信息和示例,请参阅上面链接的参考API文档。
语法
atlas api projectIpAccessList deleteAccessListEntry [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--entryValue | / | true | 要从项目的IP访问列表中删除的访问列表条目。此值可以使用以下之一:一个 AWS 群组 ID(group ID)、一个 IP 地址,或一个 CIDR 地址区块。对于使用子网掩码的 CIDR 区块,将正斜杠 (/) 替换为其URL编码值 (
|
--envelope | envelope | false | 指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题,请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。 |
--groupId | 字符串 | true | 用于标识项目的唯一 24-十六进制数字字符串。 使用 [/groups](# 标签/Projects/operation/listProjects) 端点检索身份验证的用户有权访问权限的所有项目。 注意:群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。 |
-h,--help | false | deleteAccessListEntry 的帮助 | |
-o, --output | 字符串 | false | 首选API格式,可以是 ["JSON", go-template] 此值默认为 "JSON"。 |
--outputFile | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制(例如:gzip)且命令未通过管道传输(例如: Atlas command > out.zip)时,需要使用此标志 |
--pretty | false | 指示响应正文是否应采用 prettyprint 格式的标记。 | |
--version | 字符串 | false | 调用 Atlas API 终结点时要使用的 API 版本 [选项:"2023-01-01"]。如果用户未设置,则默认为最新版本,或者如果已设置了配置文件的 api_version 值,则默认为该值。此值默认为 "2023-01-01"。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习;了解Atlas CLI配置文件,请参阅 https://dochub.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]