Docs 菜单
Docs 主页
/ /
Atlas CLI
/ / / /

atlas privateEndpoints gcp 接口描述

在此页面上

  • 语法
  • 参数
  • 选项
  • 继承选项
  • 输出
  • 示例

返回项目的特定 GCP 私有端点接口。

要使用此命令,您必须使用具有“项目只读”角色的用户帐户或 API 密钥进行身份验证。

命令语法
atlas privateEndpoints gcp interfaces describe <id> [options]
名称
类型
必需
说明
id
字符串
true
要检索的私有端点的唯一标识符。
名称
类型
必需
说明
--endpointServiceId
字符串
true
唯一的 24 字符字母数字字符串,用于标识 Atlas 中的私有端点。
-h,--help
false
描述帮助
-o, --output
字符串
false
输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。
--projectId
字符串
false
标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。
名称
类型
必需
说明
-P, --profile
字符串
false
要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。

如果命令成功,CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。

ENDPOINT STATUS DELETE REQUESTED
<EndpointGroupName> <Status> <DeleteRequested>
atlas privateEndpoints gcp interfaces describe endpoint-1 \
--endpointServiceId 61eaca605af86411903de1dd

后退

删除