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

Atlas 集群 connectionStrings describe

返回指定集群的 SRV 连接字符串。

公共预览版:从MongoDB Atlas Admin API自动生成的 atlas api 子命令提供了对 Admin API的全面覆盖,目前处于公共预览阶段(请通过以下网址提供反馈: https:// 反馈.mongodb.com/ forum/930808 -atlas-cli )。 Admin API功能有自己的发布生命周期,您可以通过提供的API端点文档链接进行检查。

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

命令语法
atlas clusters connectionStrings describe <clusterName> [options]
名称
类型
必需
说明

集群名称

字符串

true

要检索连接字符串的 Atlas 集群的名称。

名称
类型
必需
说明

-h,--help

false

描述帮助

-o, --output

字符串

false

输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。

--projectId

字符串

false

标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。

--type

字符串

false

连接string的类型。 如果指定“private”,此选项将检索网络对等互连端点的连接string 。 如果指定“privateEndpoint”,此选项将检索私有端点的分片优化连接字符串。 该值默认为“标准”。

名称
类型
必需
说明

-P, --profile

字符串

false

# Return the JSON-formatted connection strings for the cluster named myCluster:
atlas clusters connectionStrings describe myCluster --output json

后退

连接字符串(Connection Strings)

在此页面上