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

Atlas 集群 connectionStrings describe

在此页面上

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

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

要使用此命令,您必须使用具有“项目只读”角色的用户帐户或 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

要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。

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

后退

连接字符串(Connection Strings)