Atlas Streams 连接描述
返回指定 Atlas Stream Processing 连接的详细信息。
要使用此命令，您必须使用具有项目所有者角色的用户帐户或 API 密钥进行身份验证。
语法
命令语法
atlas streams connections describe <streamConnectionName> [options]
参数
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
streamConnectionName | 字符串 | true | Atlas Stream Processing 连接的名称。 |
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-h，--help | false | 描述帮助 | |
-i, --instance | 字符串 | true | Atlas Stream Processing 实例的名称。 |
-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。 |
示例
# retrieves stream connection 'ExampleConnection' in instance 'ExampleInstance': atlas streams connection describe ExampleConnection --instance ExampleInstance