Atlas API projectIpAccessList createProjectIpAccessList

Atlas CLI对使用Atlas Administration API运行命令的支持处于预览状态。在预览期间，功能和相应的文档可能随时更改。要学习；了解详情，请参阅预览功能。

MongoDB Cloud 仅允许客户端从项目的IP访问列表中的条目连接到集群。将每个条目写入一个IP解决或一个以 CIDR 表示的IP地址区块。要使用此资源，请求的API密钥必须具有项目所有者或项目Charts管理员角色。此资源将替换白名单资源。MongoDB Cloud 于 20217 月删除了白名单。更新您的应用程序以使用此新资源。/groups/{GROUP- ID}/accessList 端点管理数据库IP访问列表。此端点与 orgs/{ORG- ID}/apiKeys/{API-KEY- ID }/accesslist 端点不同，后者管理MongoDB Cloud 组织的访问权限列表。此端点不支持并发 POST 请求。您必须同步提交多个 POST 请求。

1此命令是自动生成的，对应于:1 和Atlas API端点 https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2 /# 标签/Project- IP-Access-List/operation/createProjectIpAccessList。

有关更多信息和示例，请参阅上面链接的参考API文档。

语法

命令语法

atlas api projectIpAccessList createProjectIpAccessList [options]

选项

名称	类型	必需	说明
--envelope	envelope	false	指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。
--file	字符串	false	API请求文件的路径。留空可使用标准输入 - 您必须提供其中之一，但不能同时提供两者。
--groupId	字符串	true	用于标识项目的唯一 24-十六进制数字字符串。使用 [/groups](# 标签/Projects/operation/listProjects) 端点检索身份验证的用户有权访问权限的所有项目。注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。
-h，--help		false	createProjectIpAccessList 帮助
--includeCount		false	标志，用于指示响应是否返回响应中的列项总数 (totalCount)。
--itemsPerPage	int	false	响应每页返回的列项数。
--output	字符串	false	首选API格式，可以是 ["JSON", go-template] 此值默认为 "JSON"。
--output-file	字符串	false	要将API输出写入其中的文件。当端点的输出为二进制（例如：gzip）且命令未通过管道传输（例如： Atlas command > out.zip）时，需要使用此标志
--pageNum	int	false	显示响应返回的当前总对象集的页面编号。
--pretty		false	指示响应正文是否应位于 <a href=" https://en.wikipedia.org/wiki/Prettyprint "target="_blank" rel="noopener noreferrer">pretty-print</a> 格式。
--version	字符串	false	进行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.

示例

为指定项目添加多个访问权限列表条目

创建以下文件并将其另存为 payload.json

[
  {
    "cidrBlock": "192.168.1.0/24",
    "comment": "Internal network range"
  },
  {
    "cidrBlock": "10.0.0.0/16",
    "comment": "VPC network range"
  }
]

创建 payload.json 后，在同一目录中运行以下命令。

atlas api projectIpAccessList createProjectIpAccessList --version 2023-01-01 --file payload.json --envelope false --groupId [your-project-id] --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false