返回您的集群的指定Atlas Online Archive的详细信息。
公共预览版： Atlas API子命令从MongoDB Atlas Admin API自动生成，提供对 Admin API的全面覆盖，目前处于公共预览阶段（请通过以下网址提供反馈：https://反馈.mongodb.com/forum/930808-Atlas-cli）。Admin API功能有自己的发布生命周期，您可以通过提供的API端点文档链接进行检查。
要使用此命令，您必须使用具有“项目只读”角色的用户帐户或 API 密钥进行身份验证。
语法
命令语法
atlas clusters onlineArchives describe <archiveId> [options]
参数
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
archiveId | 字符串 | true | 要检索的Atlas Online Archive的唯一标识符。 |
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--clusterName | 字符串 | true | 集群名称。要学习；了解更多信息，请参阅 https://dochub.mongodb.org/core/create-cluster-api。 |
-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 DATABASE COLLECTION STATE <Id> <ClusterName> <DbName> <CollName> <State>
示例
# Return the JSON-formatted details for the online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster: atlas clusters onlineArchives describe 5f189832e26ec075e10c32d3 --clusterName myCluster --output json