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

Atlas 集群 onlineArchives Pause

在此页面上

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

暂停为集群指定的Atlas Online Archive。

要使用此命令,您必须使用具有项目数据访问管理员角色的用户帐户或 API 密钥进行身份验证。

命令语法
atlas clusters onlineArchives pause <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 将返回类似于以下示例的输出。 括号中的值代表您的价值观。

Online archive '<Id>' paused.
# Pause the online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster:
atlas clusters onlineArchives pause 5f189832e26ec075e10c32d3 --clusterName myCluster --output json

后退

名单