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

Atlas 集群 sampleData 描述

在此页面上

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

返回指定样本数据加载作业的详细信息。

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

命令语法
atlas clusters sampleData describe <id> [options]
名称
类型
必需
说明
id
字符串
true
样本数据作业的唯一标识符。
名称
类型
必需
说明
-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 将返回类似于以下示例的输出。 括号中的值代表您的价值观。

ID CLUSTER NAME STATE
<Id> <ClusterName> <State>
# Return the JSON-formatted details for the sample data load job:
atlas clusters sampleData describe 5e98249d937cfc52efdc2a9f --output json

后退

示例数据