文档基于2025-10-10日社区最终版构建     
切换到英文版    进入演示系统    进入交流社区

MinIO Documentation

mc retention set

语法

Themc retention set命令配置Write-Once Read-Many (WORM) 锁定存储桶中一个或多个对象的设置。您还可以设置存储桶的默认对象锁定设置,所有没有显式对象锁定设置的对象都将继承存储桶的默认设置。

锁定对象于法律保留使用,mc legalhold set.

mc retention set 需要指定的存储桶已启用对象锁定功能。您可以在存储桶创建时启用对象锁定。请参阅mc mb --with-lock有关创建启用了对象锁定的存储桶的文档。

以下命令设置默认的 30 天治理对象锁定在mydata桶上的myminioMinIO 部署:

mc retention set --default GOVERNANCE "30d" myminio/mydata

该命令具有以下语法:

mc [GLOBALFLAGS] retention set                         \
                 [--bypass]                            \
                 [--default]                           \
                 [--recursive]                         \
                 [--rewind "string"]                   \
                 [--versions]                          \
                 [--version-id "string"]*              \
                 MODE                                  \
                 "VALIDITY"                            \
                 ALIAS
  • Brackets[]表示可选参数。

  • 共享同一行的参数是相互依赖的。

  • 使用竖线分隔的参数|操作符是互斥的。

将示例复制到文本编辑器中,根据需要修改,然后在终端/Shell中运行命令。

mc retention set --version-id与多个其他参数互斥。有关更多信息,请参阅参考文档。

参数

MODE
必需

设置锁定模式为ALIAS请指定以下支持的值之一:

  • governance

  • compliance

请参阅 AWS S3 文档中的对象锁定概述有关支持的模式的更多信息,请参阅相关文档。

需要指定VALIDITY.

有效性
必需

对象在指定状态中保持的持续时间MODE创建后。

  • 对于天数,请指定一个格式化的字符串Nd例如,

    30d在对象创建后的30天内。

  • 多年来,指定一个格式化的字符串为Ny例如,

    1y自对象创建之日起1年内。

ALIAS
必需

对象或对象组的完整路径,用于设置对象锁定配置。指定别名对于 MinIO 或 S3 兼容服务以及存储桶的完整路径。例如:

mc retention set play/mybucket/object.txt MODE VALIDITY
  • 如果ALIAS指定一个存储桶或存储桶前缀,包含--recursive对存储桶内容应用对象锁定设置。

  • mc retention set默认情况下仅适用于最新的对象版本。使用--version-id or --versions将对象锁定设置分别应用于特定版本或对象的所有版本。

--绕过
可选

允许具有s3:BypassGovernanceRetention修改对象的权限。需要governance留存率MODE

--default
可选

设置指定存储桶的默认对象锁定设置ALIAS使用MODEVALIDITY存储桶中创建的任何对象都会继承默认的对象锁定设置, 除非使用mc retention set.

如果指定--default, mc retention set忽略所有其他标志。

--recursive, --r
可选

递归地将对象锁定设置应用到指定目录中的所有对象上ALIASpath.

与以下内容互斥--version-id.

--rewind
可选

Directsmc retention set仅对指定时间点存在的对象版本进行操作。

  • 要回滚到过去的特定日期,请将日期指定为 ISO8601格式的时间戳。例如:--rewind "2020.03.24T10:00".

  • 要倒回一段时间,请将持续时间指定为字符串,格式为#d#hh#mm#ss格式。例如:--rewind "1d2hh3mm4ss".

--rewind要求指定的ALIAS成为兼容 S3 的服务 并支持Bucket Versioning对于 MinIO 部署,请使用mc version启用或禁用存储桶版本控制。

--version-id, --vid
可选

Directsmc retention set仅对指定的对象版本进行操作。

--version-id要求指定的ALIAS成为兼容 S3 的服务 并支持Bucket Versioning对于 MinIO 部署,请使用mc version启用或禁用存储桶版本控制。

与以下任何标志互斥:

--versions
可选

Directsmc retention set对存储桶中存在的所有对象版本执行操作。

--versions要求指定的ALIAS成为兼容 S3 的服务 并支持Bucket Versioning对于 MinIO 部署,请使用mc version启用或禁用存储桶版本控制。

使用--versions--rewind共同将保留设置应用于在特定时间点存在的所有对象版本。

全局标志

此命令支持任何全局标志.

示例

设置默认存储桶保留设置

使用mc retention set随着--recursive--default设置默认存储桶的保留设置。

mc retention set  --recursive --default MODE DURATION ALIAS/PATH
  • 替换MODE使用保留模式来 启用。MinIO 支持 AWS S3 保留模式governancecompliance.

  • 替换DURATION对象锁定应保持生效的持续时间。例如,要设置30天的保留期,请指定30d.

  • 替换ALIAS随着alias已配置的 S3 兼容主机。

  • 替换PATH使用存储桶的路径。

这个存储桶必须要使用此命令,需要启用对象锁定功能。 您只能在创建存储桶时启用对象锁定功能。请参阅mc mb --with-lock有关启用对象锁定功能创建存储桶的更多信息。

为版本化对象设置对象锁定配置

使用mc retention setwith--version-id要将保留设置应用于特定对象版本:

mc retention set --version-id VERSION MODE DURATION ALIAS/PATH
  • 替换VERSION与对象的版本。

  • 替换MODE使用保留模式 来启用。MinIO 支持 AWS S3 保留模式governancecompliance.

  • 替换DURATION在对象锁定应保持生效的持续时间。例如,要设置30天的保留期,请指定30d.

  • 替换ALIAS随着alias已配置的 S3 兼容主机。

  • 替换PATH指向该对象的路径。

使用mc retention setwith--versions要将保留设置应用于特定对象版本:

mc retention set --versions  MODE DURATION ALIAS/PATH
  • 替换MODE使用保留模式 来启用。MinIO 支持 AWS S3 保留模式governancecompliance.

  • 替换DURATION在对象锁定应保持生效的持续时间。例如,要设置30天的保留期,请指定30d.

  • 替换ALIAS随着alias已配置的 S3 兼容主机。

  • 替换PATH指向该对象的路径。

这个存储桶必须要使用此命令,需要启用对象锁定功能。 您只能在创建存储桶时启用对象锁定功能。请参阅mc mb --with-lock有关启用对象锁定功能创建存储桶的更多信息。

行为

对象版本保留

对于具有versioning enabled, mc retention set默认情况下,在以下情况下运行最新目标对象或对象们的版本。mc retention set包含特定选项,当明确地指定命令对特定对象版本进行操作or对象的所有版本:

直接mc retention set要对特定版本的对象进行操作,请包含--version-id论点:

直接mc retention set进行操作全部对象版本, 包括--versions论点:

S3 Compatibility

Themc命令行工具专为兼容 AWS S3 API 而构建,并已通过 MinIO 和 AWS S3 测试,确保功能与行为符合预期。

MinIO 不提供对其他 S3 兼容服务的保证,因为它们的 S3 API 实现方式未知,因此不受支持。尽管mc命令可能按文档所述工作,任何此类使用风险自负。