实验:将联合数据库实例和在线存档的一个私有端点添加到指定项目。
如果端点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 是 com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb 。eu-west-1 是 com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e。eu-west-2 是 com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9。eu-central-1 是 com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d。sa-east-1 是 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密钥必须具有项目所有者或项目Charts管理员角色。此命令正在调用 OperationID 为“createDataFederationPrivateEndpoint”的端点。有关标志、文件格式和示例的更多信息,请参阅:https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#标签/Data-Federation/operation/createDataFederationPrivateEndpoint
语法
atlas api dataFederation createDataFederationPrivateEndpoint [options]
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--envelope | false | 标志,指示应用程序是否将响应包装在信封JSON对象中 | |
--file | 字符串 | false | 包含API请求内容的文件的路径 |
--groupId | 字符串 | true | 用于标识项目的唯一 24-十六进制数字字符串 |
-h,--help | false | createDataFederationPrivateEndpoint 帮助 | |
--output | 字符串 | false | 首选API格式,可以是 ["JSON", go-template] 此值默认为 "JSON"。 |
--output-file | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制(例如:gzip)且命令未通过管道传输(例如: Atlas command > out.zip)时,需要使用此标志 |
--pretty | false | 标志,指示响应正文是否应采用美观打印格式 | |
--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。 |