atlas clusters onlineArchives 更新

在此页面上

语法

参数
选项
继承选项
输出
举例

修改集群指定的Atlas Online Archive的存档规则。

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

语法

命令语法

atlas clusters onlineArchives update <archiveId> [options]

参数

名称	类型	必需	说明
archiveId	字符串	true	要更新的Atlas Online Archive的唯一标识符。

选项

名称	类型	必需	说明
--archiveAfter	int	false	存档集群数据的天数。与 --文件互斥。
--clusterName	字符串	true	集群名称。
--expireAfterDays	int	false	指定删除文档的日期条件中使用的天数。与 --文件互斥。
--file	字符串	false	定义在线存档设置的可选 JSON 配置文件的路径。要了解有关 Atlas CLI 在线存档配置文件的更多信息，请参阅 https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config。与 --archiveAfter、--expireAfterDays 互斥。
-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>' updated.

举例

# Update the archiving rule to archive after 5 days for the online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster:
atlas clusters onlineArchives update 5f189832e26ec075e10c32d3 --clusterName --archiveAfter 5 myCluster --output json

MongoDB Atlas 是什么？ →