将联合数据库实例和在线存档的一个私有端点添加到指定项目。
atlas api 子命令是从MongoDB Atlas Admin API自动生成的，并提供对 Admin API的全面覆盖。 Admin API功能有自己的发布生命周期，您可以通过提供的API端点文档链接进行检查。
如果终结点 ID 已存在且关联注释未更改，则 Atlas Data Federation 不会更改终结点 ID 列表。如果终结点 ID 已存在且关联注释发生更改，则 Atlas Data Federation 仅更新终结点 ID 列表中的注释值。如果终结点 ID 不存在，Atlas Data Federation 会将新终结点附加到终结点 ID 列表中的终结点列表中。每个区域都有每个区域中各种终结点的关联服务名称。
us-east-1 是 com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4。
us-west-1 is com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb.
eu-west-1 is com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e.
eu-west-2 is com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9.
eu-central-1 is com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d.
sa-east-1 is com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044.
ap-southeast-2 是 com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e。
ap-south-1 是 com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d。
要使用此资源，请求的服务帐户或 API 密钥必须具有“项目所有者”或“项目图表管理员”角色。
1此命令是自动生成的，对应:1 与Atlas API端点 https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2 /operation/ operation-creategroupprivatenetworksettingendpointid。
有关更多信息和示例，请参阅上面链接的参考API文档。
语法
atlas api dataFederation createPrivateEndpointId [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 | createPrivateEndpointId 帮助 | |
-o, --output | 字符串 | false | 首选API格式，可以是 ["JSON", go-template] 此值默认为 "JSON"。 |
--outputFile | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制（例如：gzip）且命令未通过管道传输（例如： Atlas command > out.zip）时，需要使用此标志 |
--pretty | false | 指示响应正文是否应采用 prettyprint 格式的标记。 | |
--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。 |