Silo 客户端（mcli / mc）

• 1: mc alias list
• 2: mc anonymous set
• 3: mc batch cancel
• 4: mc encrypt clear
• 5: mc event add
• 6: mc idp ldap accesskey disable
• 7: mc idp ldap add
• 8: mc idp ldap policy attach
• 9: mc ilm restore
• 10: mc ilm rule add
• 11: mc ilm tier add
• 12: mc legalhold clear
• 13: mc license info
• 14: mc replicate add
• 15: mc retention set
• 16: mc share download
• 17: mc support callhome
• 18: mc support top api
• 19: mc tag set
• 20: mc version enable
• 21: Silo 客户端设置
• 22: mc alias
• 23: mc alias remove
• 24: mc anonymous get
• 25: mc batch describe
• 26: mc encrypt info
• 27: mc event ls
• 28: mc idp ldap accesskey edit
• 29: mc idp ldap disable
• 30: mc idp ldap policy detach
• 31: mc ilm rule
• 32: mc ilm rule edit
• 33: mc ilm tier check
• 34: mc legalhold info
• 35: mc license register
• 36: mc replicate backlog
• 37: mc retention info
• 38: mc share upload
• 39: mc support diag
• 40: mc support top locks
• 41: mc tag list
• 42: mc version info
• 43: mc alias set
• 44: mc anonymous
• 45: mc anonymous list
• 46: mc batch generate
• 47: mc encrypt set
• 48: mc event rm
• 49: mc idp ldap accesskey enable
• 50: mc idp ldap enable
• 51: mc idp ldap policy entities
• 52: mc ilm rule export
• 53: mc ilm tier
• 54: mc ilm tier info
• 55: mc legalhold set
• 56: mc license update
• 57: mc replicate ls
• 58: mc retention clear
• 59: mc share ls
• 60: mc support inspect
• 61: mc support top disk
• 62: mc tag remove
• 63: mc version suspend
• 64: mc alias import
• 65: mc anonymous links
• 66: mc batch
• 67: mc batch list
• 68: mc idp ldap accesskey info
• 69: mc idp ldap info
• 70: mc ilm rule import
• 71: mc ilm tier ls
• 72: mc replicate update
• 73: mc support perf
• 74: mc support top net
• 75: mc alias export
• 76: mc anonymous get-json
• 77: mc batch start
• 78: mc cat
• 79: mc idp ldap accesskey ls
• 80: mc idp ldap ls
• 81: mc ilm rule ls
• 82: mc ilm tier rm
• 83: mc replicate resync
• 84: mc support profile
• 85: mc support top rpc
• 86: mc anonymous set-json
• 87: mc batch status
• 88: mc cp
• 89: mc idp ldap accesskey rm
• 90: mc idp ldap rm
• 91: mc ilm rule rm
• 92: mc ilm tier update
• 93: mc replicate rm
• 94: mc support proxy
• 95: mc diff
• 96: mc idp ldap update
• 97: mc replicate status
• 98: mc support top
• 99: mc du
• 100: mc replicate export
• 101: mc support upload
• 102: mc encrypt
• 103: mc replicate import
• 104: mc event
• 105: mc find
• 106: mc get
• 107: mc head
• 108: mc idp ldap
• 109: mc idp ldap accesskey
• 110: mc idp ldap accesskey create-with-login
• 111: mc idp ldap policy
• 112: mc idp openid
• 113: mc ilm
• 114: mc legalhold
• 115: mc license
• 116: mc ls
• 117: mc mb
• 118: mc mirror
• 119: mc mv
• 120: mc od
• 121: mc ping
• 122: mc pipe
• 123: mc put
• 124: mc rb
• 125: mc ready
• 126: mc replicate
• 127: mc retention
• 128: mc rm
• 129: mc share
• 130: mc sql
• 131: mc stat
• 132: mc support
• 133: mc tag
• 134: mc tree
• 135: mc undo
• 136: mc update
• 137: mc version
• 138: mc watch
• 139: mc idp ldap accesskey create

mc [GLOBALFLAGS] COMMAND --help

git clone https://github.com/pgsty/mc.git
cd mc
make build
./mc --version

bash +o history
mc alias set ALIAS HOSTNAME ACCESS_KEY SECRET_KEY
bash -o history

mc alias set silo https://silo.example.net ACCESS_KEY SECRET_KEY

mc alias set myS3 https://s3.{your-region-code}.amazonaws.com/endpoint ACCESS_KEY SECRET_KEY

mc alias set myGCS https://storage.googleapis.com/endpoint ACCESS_KEY SECRET_KEY

mc admin info silo

~/.mc/certs/ # certificates
~/.mc/certs/CAs/ # Certificate Authorities

C:\Users\[username]\mc\certs\ # certificates
C:\Users\[username]\mc\certs\CAs\ # Certificate Authorities

mc --debug ls play

mc --json ls play

--resolve HOST[:PORT]=IP

mc alias set --resolve myminio.example.com:9000=192.168.188.118 'myminio' 'https://myminio.example.com:9000' 'miniouser' 'miniosecret'

1 - mc alias list

语法

mc alias list 命令列出本地 mc 配置中的所有别名。

该命令输出包含每个别名关联的 access key 和 secret key 配置。

mc alias list

mc [GLOBALFLAGS] alias list [ALIAS]

参数

ALIAS

mc-cmd

可选 要显示的特定别名名称。

全局标志

此命令支持 全局标志 中的任意选项。

示例

列出所有已配置别名

mc alias list

mc alias list

列出特定别名

mc alias list myminio

mc alias list ALIAS

行为

S3 兼容性

mc 命令行工具以兼容 AWS S3 API 为目标构建，并针对 MinIO 和 AWS S3 进行了测试，以验证预期的功能与行为。

对于其他 S3 兼容服务，MinIO 不提供任何保证，因为这些服务的 S3 API 实现未知， 因此不在支持范围内。虽然 mc 命令 可能 仍能按文档说明工作，但此类 用法需要你自行承担风险。

2 - mc anonymous set

语法

mc anonymous set 命令为存储桶设置匿名（即未认证或公开）访问 策略。

配置了匿名策略的存储桶允许客户端在无需 身份验证 的情况下， 访问存储桶内容并执行与指定策略一致的操作。

要使用 IAM JSON 策略设置存储桶匿名策略，请使用 mc anonymous set-json 命令。

mc anonymous set upload myminio/uploads
mc anonymous set download myminio/downloads
mc anonymous set public myminio/public

mc [GLOBALFLAGS] policy set PERMISSION ALIAS

参数

PERMISSION

mc-cmd

必需 要分配给指定 ALIAS 的策略名称。 指定以下值之一：

• none - 禁用对 ALIAS 的匿名访问。
• download - 启用对 ALIAS 的仅下载访问。
• upload - 启用对 ALIAS 的仅上传访问。
• public - 启用对 ALIAS 的下载和上传访问。

ALIAS

mc-cmd

必需 要应用指定 PERMISSION 的存储桶或存储桶前缀的完整路径。

指定 MinIO 或其他 S3 兼容服务的 alias，以及 存储桶或存储桶前缀的完整路径。例如：

mc anonymous set public play/mybucket

指定存储桶前缀可仅对该前缀设置策略。例如，以下命令分别为 mybucket/downloads 和 mybucket/uploads 前缀设置不同的匿名存储桶策略：

mc anonymous set download play/mybucket/downloads
mc anonymous set upload play/mybucket/uploads

全局标志

此命令支持 全局标志 中的任意选项。

示例

为存储桶设置匿名策略

使用 mc anonymous set 为存储桶设置匿名策略：

mc anonymous set POLICY ALIAS/PATH

• 将 POLICY 替换为受支持的 permission。
• 将 ALIAS 替换为已配置 S3 兼容主机的 alias。
• 将 PATH 替换为目标存储桶。

行为

S3 兼容性

mc 命令行工具以兼容 AWS S3 API 为目标构建，并针对 MinIO 和 AWS S3 进行了测试，以验证预期的功能与行为。

对于其他 S3 兼容服务，MinIO 不提供任何保证，因为这些服务的 S3 API 实现未知， 因此不在支持范围内。虽然 mc 命令 可能 仍能按文档说明工作，但此类 用法需要你自行承担风险。

3 - mc batch cancel

语法

mc batch cancel 可停止正在进行的批处理作业。

您必须指定作业 ID。 要查找作业 ID，请使用 mc batch list。

mc batch cancel myminio KwSysDpxcBU9FNhGkn2dCf

mc [GLOBALFLAGS] batch cancel ALIAS JOBID

参数

ALIAS

mc-cmd

Required

当前运行该作业的 MinIO 部署的 alias。

JOBID

mc-cmd

Required

要取消的批处理作业的唯一标识符。 要查找作业 ID，请使用 mc batch list。

全局参数

此命令支持 全局标志 中的任意选项。

示例

取消正在进行的批处理作业

以下命令会取消别名为 myminio 的部署上 ID 为 KwSysDpxcBU9FNhGkn2dCf 的作业：

mc batch cancel myminio KwSysDpxcBU9FNhGkn2dCf

S3 兼容性

mc 命令行工具以兼容 AWS S3 API 为目标构建，并针对 MinIO 和 AWS S3 进行了测试，以验证预期的功能与行为。

对于其他 S3 兼容服务，MinIO 不提供任何保证，因为这些服务的 S3 API 实现未知， 因此不在支持范围内。虽然 mc 命令 可能 仍能按文档说明工作，但此类 用法需要你自行承担风险。

4 - mc encrypt clear

语法

mc encrypt clear 命令用于移除存储桶当前的默认加密设置。

mc encrypt clear myminio/mydata

mc [GLOBALFLAGS] encrypt clear ALIAS

参数

ALIAS

mc-cmd

要移除默认 SSE 模式的目标存储桶完整路径。 指定 MinIO 部署的 alias 作为 ALIAS 路径前缀。例如：

mc encrypt clear play/mybucket

全局标志

此命令支持 全局标志 中的任意选项。

示例

移除存储桶的自动服务端加密设置

 mc encrypt clear myminio/data

mc encrypt clear ALIAS

行为

修改存储桶加密设置不会影响已加密对象

禁用存储桶自动加密 不会 解密该存储桶中的任何对象。

要永久解密存储桶中的对象，可在禁用对象解密后执行原地复制。 对于启用版本控制的存储桶，旧版本对象仍保持加密状态。

S3 兼容性

mc 命令行工具以兼容 AWS S3 API 为目标构建，并针对 MinIO 和 AWS S3 进行了测试，以验证预期的功能与行为。

对于其他 S3 兼容服务，MinIO 不提供任何保证，因为这些服务的 S3 API 实现未知， 因此不在支持范围内。虽然 mc 命令 可能 仍能按文档说明工作，但此类 用法需要你自行承担风险。

5 - mc event add

语法

mc event add 命令为存储桶添加事件通知触发器。

MinIO 会将已触发的事件自动发送到已配置的 notification target。

mc event add --event "put,delete" myminio/mydata arn:aws:sqs::primary:target

mc [GLOBALFLAGS] event add \
                 [--event "string"]  \
                 [--ignore-existing] \
                 [--prefix "string"] \
                 [--suffix "string"] \
                 ALIAS               \
                 ARN

参数

ALIAS

mc-cmd

Required

要添加新事件通知的 MinIO alias 和存储桶。 例如：

mc event add play/mybucket

ARN

mc-cmd

Required

通知目标的 Amazon Resource Name (ARN)。

MinIO 服务器启动时会为每个已配置的通知目标输出一个 ARN。 更多信息请参见 存储桶通知。

--event

mc-cmd

Optional

MinIO 生成存储桶通知所依据的事件。

支持以下取值：

• put
• get
• delete

使用逗号 , 分隔可指定多个值。 值之间不要添加空白字符。

如果未指定，默认值为 put,delete,get。

各支持值对应的 S3 事件详见 支持的存储桶事件。

ignore-existing, p

mc-cmd

Optional

如果已存在匹配的触发器，则指示 MinIO 忽略指定的事件触发器。

--prefix

mc-cmd

Optional

指定可由 --event 触发存储桶通知的存储桶前缀。

例如，若 ALIAS 为 play/mybucket 且 --prefix 为 photos，则只有 play/mybucket/photos 中的事件会触发存储桶通知。

省略该参数时，存储桶中所有前缀和对象的事件都可触发通知。

--suffix

mc-cmd

Optional

指定可由 --event 触发存储桶通知的存储桶后缀。

例如，若 ALIAS 为 play/mybucket 且 --suffix 为 .jpg，则只有 play/mybucket/*.jpg 中的事件会触发存储桶通知。

省略该参数时，无论后缀为何，所有对象的事件都可触发通知。

全局标志

此命令支持 全局标志 中的任意选项。

示例

为存储桶添加事件通知

mc event add myminio/mydata arn:minio:sqs::primary:webhook

mc event add ALIAS ARN

行为

支持的存储桶事件

下表列出了 mc event add 支持的取值及其对应的 S3 events：

有关上述 S3 事件的更完整文档，请参见 S3 Supported Event Types。

S3 兼容性

mc 命令行工具以兼容 AWS S3 API 为目标构建，并针对 MinIO 和 AWS S3 进行了测试，以验证预期的功能与行为。

对于其他 S3 兼容服务，MinIO 不提供任何保证，因为这些服务的 S3 API 实现未知， 因此不在支持范围内。虽然 mc 命令 可能 仍能按文档说明工作，但此类 用法需要你自行承担风险。

6 - mc idp ldap accesskey disable

描述

mc idp ldap accesskey disable 会在 MinIO 部署上禁用指定的 access key。

mc idp ldap accesskey disable minio mykey

mc [GLOBALFLAGS] idp ldap accesskey disable  \
                                 ALIAS       \
                                 KEY

参数

ALIAS

mc-cmd

Required

已配置 AD/LDAP 的 MinIO 部署的 alias。

例如：

mc idp ldap accesskey disable minio

KEY

mc-cmd

Required

要禁用的已配置访问密钥。

示例

禁用 minio 部署中的访问密钥 mykey。

mc idp ldap accesskey disable minio/ mykey

全局标志

此命令支持 全局标志 中的任意选项。

行为

S3 兼容性

mc 命令行工具以兼容 AWS S3 API 为目标构建，并针对 MinIO 和 AWS S3 进行了测试，以验证预期的功能与行为。

对于其他 S3 兼容服务，MinIO 不提供任何保证，因为这些服务的 S3 API 实现未知， 因此不在支持范围内。虽然 mc 命令 可能 仍能按文档说明工作，但此类 用法需要你自行承担风险。

7 - mc idp ldap add

描述

mc idp ldap add 命令用于创建 AD/LDAP IDP 服务器配置。

每个 MinIO 部署最多仅支持 一个 (1) AD/LDAP 提供商。

mc idp ldap add                                                            \
            myminio                                                        \
            server_addr=myldapserver:636                                   \
            lookup_bind_dn=cn=admin,dc=min,dc=io                           \
            lookup_bind_password=somesecret                                \
            user_dn_search_base_dn=dc=min,dc=io                            \
            user_dn_search_filter="(uid=%s)"                               \
            group_search_base_dn=ou=swengg,dc=min,dc=io                    \
            group_search_filter="(&(objectclass=groupofnames)(member=%d))"

mc [GLOBALFLAGS] idp ldap add               \
                          ALIAS             \
                          [CFG_PARAM1]      \
                          [CFG_PARAM2]...

参数

ALIAS

mc-cmd

Required

要添加 AD/LDAP 集成的 MinIO 部署的 alias。

例如：

mc idp ldap add myminio                               \
                server_addr=myldapserver:636          \
                lookup_bind_dn=cn=admin,dc=min,dc=io  \
                lookup_bind_password=somesecret       \
                user_dn_search_base_dn=dc=min,dc=io   \
                user_dn_search_filter="(uid=%s)"      \

server_addr

mc-cmd

Required

指定 Active Directory / LDAP server 的主机名。例如：

ldapserver.com:636

该参数对应环境变量 MINIO_IDENTITY_LDAP_SERVER_ADDR。

lookup_bind_dn

mc-cmd

Required

指定 MinIO 在查询 AD/LDAP server 时所使用的 AD/LDAP 账户 Distinguished Name (DN)。 这会启用对 AD/LDAP server 的 Lookup-Bind 认证。

该 DN 账户应为只读访问账号，并具备足够权限以支持执行用户和组查询。

该参数对应环境变量 MINIO_IDENTITY_LDAP_LOOKUP_BIND_DN。

lookup_bind_password

mc-cmd

Required

指定 Lookup-Bind 用户账户的密码。

该参数对应环境变量 MINIO_IDENTITY_LDAP_LOOKUP_BIND_PASSWORD。

user_dn_attributes

mc-cmd

Optional

用户 DN 属性的逗号分隔列表。

一些有效值包括 uid,cn,mail,sshPublicKey。

如果要为 LDAP 用户启用公钥认证，请将 sshPublicKey 作为 DN 属性传入。 随后，用户即可使用传入的 SSH Public Key 登录 SFTP server。

mc idp ldap update ALIAS user_dn_attributes=sshPublicKey

user_dn_search_base_dn

mc-cmd

Required

指定 MinIO 在查询与认证客户端所提供凭证相匹配的用户凭证时所使用的基础 Distinguished Name (DN)。

多个 DN 之间请使用分号（;）分隔。

例如：

cn=miniousers,dc=myldapserver,dc=net;ou=swengg,dc=min,dc=io

支持 Lookup-Bind 模式。

该参数对应环境变量 MINIO_IDENTITY_LDAP_USER_DN_SEARCH_BASE_DN。

user_dn_search_filter

mc-cmd

Required

指定 MinIO 在查询与认证客户端所提供凭证相匹配的用户凭证时所使用的 AD/LDAP 搜索过滤器。

使用 %s 替换字符将客户端指定的用户名插入搜索字符串。例如：

(userPrincipalName=%s)

该参数对应环境变量 MINIO_IDENTITY_LDAP_USER_DN_SEARCH_FILTER。

comment

mc-cmd

Optional

指定要附加到 AD/LDAP 配置上的注释。

该参数对应环境变量 MINIO_IDENTITY_LDAP_COMMENT。

enabled

mc-cmd

Optional

设为 false 可禁用 AD/LDAP 配置。

如果设为 false，应用程序将无法生成 STS 凭证， 也无法再使用已配置的提供者向 MinIO 进行身份验证。

默认为 true，即 “enabled”。

group_search_base_dn

mc-cmd

Optional

指定 MinIO 在执行组查询时所使用的组搜索基础 Distinguished Names 列表，多个值之间使用分号（;）分隔。

例如：

cn=miniogroups,dc=myldapserver,dc=net;ou=swengg,dc=min,dc=io

该参数对应环境变量 MINIO_IDENTITY_LDAP_GROUP_SEARCH_BASE_DN。

group_search_filter

mc-cmd

Optional

指定用于为已认证用户执行组查询的 AD/LDAP 搜索过滤器。

使用 %s 替换字符将客户端指定的用户名插入搜索字符串。 使用 %d 替换字符将客户端指定用户名对应的 Distinguished Name 插入搜索字符串。

例如：

(&(objectclass=groupOfNames)(memberUid=%s))

在提供 AD/LDAP 组搜索过滤器时，应将其配置为仅返回支持认证所需的最少相关组。 返回大量组成员关系的过滤器会增加相关调用和资源的体量。 对大请求体或大响应体敏感的功能可能因此出现意外行为。

该参数对应环境变量 MINIO_IDENTITY_LDAP_GROUP_SEARCH_FILTER。

server_insecure

mc-cmd

Optional

指定 on 可允许与 AD/LDAP server 建立未加密的连接（非 TLS）。

MinIO 会以明文形式将 AD/LDAP 用户凭证发送到 AD/LDAP server，因此 必须 启用 TLS，才能防止凭证在传输过程中被读取。 启用此选项会带来安全风险，因为任何能够访问网络流量的用户都可能看到未加密的明文 凭证。

默认值为 off。

该参数对应环境变量 MINIO_IDENTITY_LDAP_SERVER_INSECURE。

server_starttls

mc-cmd

Optional

指定 on 可启用到 AD/LDAP server 的 StartTLS 连接。

默认值为 off

有关 StartTLS 的更多信息，请参见 LDAP RFC 4511 specification 第 4.14 节。

该参数对应环境变量 MINIO_IDENTITY_LDAP_SERVER_STARTTLS。

srv_record_name

mc-cmd

Optional

指定适当的值，以允许 MinIO 通过 DNS SRV record 请求选择 AD/LDAP server。

启用后，MinIO 会通过以下方式选择 AD/LDAP server：

• 按标准命名约定构造目标 SRV 记录名称。
• 请求可用的 AD/LDAP server 列表。
• 根据优先级和权重选择合适的目标。

下面的配置示例假定 AD/LDAP server 地址设为 example.com，SRV 记录协议为 _tcp。

对于以 _ldap 开头的 SRV 记录名称，指定 ldap。 构造出的 DNS SRV 记录名称类似如下：

_ldap._tcp.example.com

对于以 _ldaps 开头的 SRV 记录名称，指定 ldaps。 构造出的 DNS SRV 记录名称类似如下：

_ldaps._tcp.example.com

如果你的 DNS SRV 记录名称使用了其他 service 或 protocol 名称，请指定 on， 并将完整记录名称作为 LDAP server 地址提供。 例如：_ldapserver._specialtcp.example.com

有关 DNS SRV 记录的更多信息，请参见 DNS SRV Records for LDAP。

该参数对应环境变量 MINIO_IDENTITY_LDAP_SRV_RECORD_NAME。

tls_skip_verify

mc-cmd

Optional

指定 on 可在不验证的情况下信任 AD/LDAP server 的 TLS 证书。 如果 AD/LDAP server 的 TLS 证书由不受信任的证书颁发机构签名 （例如自签名），则可能需要此选项。

默认值为 off

该参数对应环境变量 MINIO_IDENTITY_LDAP_TLS_SKIP_VERIFY。

全局标志

此命令支持 全局标志 中的任意选项。

行为

S3 兼容性

mc 命令行工具以兼容 AWS S3 API 为目标构建，并针对 MinIO 和 AWS S3 进行了测试，以验证预期的功能与行为。

对于其他 S3 兼容服务，MinIO 不提供任何保证，因为这些服务的 S3 API 实现未知， 因此不在支持范围内。虽然 mc 命令 可能 仍能按文档说明工作，但此类 用法需要你自行承担风险。

8 - mc idp ldap policy attach

描述

mc idp ldap policy attach 命令将一个或多个策略附加到实体。

mc idp ldap policy attach myminio                                                  \
                          userpolicy                                               \
                          --user='uid=bobfisher,ou=people,ou=hwengg,dc=min,dc=io'

mc [GLOBALFLAGS] idp ldap policy attach             \
                                 POLICYNAME         \
                                 [POLICY2] ...      \
                                 ALIAS              \
                                 [--user=`USER`]    \
                                 [--group=`GROUP`]

参数

ALIAS

mc-cmd

Required

MinIO 部署的 alias，其中包含要附加策略的实体。

例如：

mc idp ldap policy attach myminio                                                  \
                          userpolicy                                               \
                          --user='uid=bobfisher,ou=people,ou=hwengg,dc=min,dc=io'

示例

以下示例将两个策略 policy1 和 policy2 附加到 myminio 部署中的 projectb 组：

mc idp ldap policy attach myminio                                                 \
                          policy1                                                 \
                          policy2                                                 \
                          --group='cn=projectb,ou=groups,ou=swengg,dc=min,dc=io'

全局标志

此命令支持 全局标志 中的任意选项。

行为

S3 兼容性

mc 命令行工具以兼容 AWS S3 API 为目标构建，并针对 MinIO 和 AWS S3 进行了测试，以验证预期的功能与行为。

对于其他 S3 兼容服务，MinIO 不提供任何保证，因为这些服务的 S3 API 实现未知， 因此不在支持范围内。虽然 mc 命令 可能 仍能按文档说明工作，但此类 用法需要你自行承担风险。

9 - mc ilm restore

语法

mc ilm restore 命令会为归档在远程层上的对象创建一个临时副本。 默认情况下，该副本会在 1 天后自动过期。

使用此命令可让应用程序通过 MinIO 部署访问分层对象（例如“热层”）。 归档对象会保留在远程层，而临时副本会成为该对象的 HEAD。

mc ilm restore myminio/mybucket/object.txt

mc [GLOBALFLAGS] ilm restore         \
                 [--days "int" ]     \
                 [--recursive]       \
                 [--vid "string"]    \
                 [--versions]        \
                 [--enc-c "string"]  \
                 ALIAS

参数

ALIAS

mc-cmd

Required

要恢复的归档对象对应的 MinIO alias、存储桶和路径。

mc ilm restore myminio/mybucket/object.txt

--days

mc-cmd

Optional

MinIO 使已恢复归档对象副本过期前的天数。

--enc-c

mc-cmd

Optional

使用客户端管理的密钥，通过服务端 SSE-C 加密 对对象进行加密或解密。

该参数接受格式为 KEY=VALUE 的键值对。

• KEY - 对象的完整路径，格式为 alias/bucket/path/object。
• VALUE - 用于加密对象的 32 字节 RAW Base64 编码数据密钥。

例如：

# RawBase64-Encoded string "mybucket32byteencryptionkeyssec"
--enc-c "myminio/mybucket/prefix/object.obj=bXlidWNrZXQzMmJ5dGVlbmNyeXB0aW9ua2V5c3NlYwo"

你可以通过重复该参数来指定多个加密密钥。

也可以指定某个前缀路径，对该路径下所有匹配对象应用加密：

--enc-c "myminio/mybucket/prefix/=bXlidWNrZXQzMmJ5dGVlbmNyeXB0aW9ua2V5c3NlYwo"

--recursive, r

mc-cmd

Optional

恢复指定前缀下的所有对象。

--versions

mc-cmd

Optional

恢复远程层上该对象的所有版本。

--version-id, vid

mc-cmd

Optional

恢复远程层上该对象的指定版本。

全局参数

此命令支持 全局标志 中的任意选项。

示例

恢复归档对象

以下命令恢复一个已归档到远程层的对象：

mc ilm restore myminio/mybucket/object.txt

恢复指定版本的归档对象

以下命令恢复一个已归档到远程层的指定对象版本：

mc ilm restore --vid "VERSIONID" myminio/mybucket/object.txt

恢复存储桶前缀下的所有归档对象

以下命令恢复远程层上指定前缀下归档的所有对象：

mc ilm restore --recursive myminio/mybucket/data/

行为

已恢复对象自动过期

MinIO 会在指定天数后自动使已恢复对象副本过期（默认：1 天）。

已恢复对象会成为 HEAD

无论该对象命名空间的版本控制历史如何，已恢复的对象副本都会成为 HEAD。 在本地副本存在期间，这可能导致应用程序返回“过时”数据。

S3 兼容性

mc 命令行工具以兼容 AWS S3 API 为目标构建，并针对 MinIO 和 AWS S3 进行了测试，以验证预期的功能与行为。

对于其他 S3 兼容服务，MinIO 不提供任何保证，因为这些服务的 S3 API 实现未知， 因此不在支持范围内。虽然 mc 命令 可能 仍能按文档说明工作，但此类 用法需要你自行承担风险。

10 - mc ilm rule add

语法

mc ilm rule add 命令用于向存储桶添加对象生命周期管理规则。

该命令支持添加 迁移（分层） 和 过期 两类生命周期管理规则。

mc ilm rule add --expire-days 90 --noncurrent-expire-days 30  myminio/mydata

mc ilm rule add --expire-delete-marker myminio/mydata

mc ilm rule add --transition-days 30 --transition-tier "COLDTIER" myminio/mydata

mc ilm rule add --noncurrent-transition-days 7 --noncurrent-transition-tier "COLDTIER"

mc [GLOBALFLAGS] ilm rule add                               \
                 [--prefix string]                          \
                 [--tags string]                            \
                 [--expire-days "integer"]                  \
                 [--expire-all-object-versions]             \
                 [--expire-delete-marker]                   \
                 [--transition-days "string"]               \
                 [--transition-tier "string"]               \
                 [--noncurrent-expire-days "integer"]       \
                 [--noncurrent-expire-newer "integer"]      \
                 [--noncurrent-transition-days "integer"]   \
                 [--noncurrent-transition-tier "string"]    \
                 [--site-gt "string"]                       \
                 [--size-lt "string"]                       \
                 ALIAS

参数

ALIAS

mc-cmd

Required

MinIO 部署上用于添加对象生命周期管理规则的 alias 和存储桶。

例如：

mc ilm rule add myminio/mydata

--prefix

mc-cmd

Optional

将管理规则限定到特定对象前缀。

例如：

mc ilm rule add --prefix "meetingnotes/" myminio/mydata --expire-days "90"

该命令会创建一条规则：对于 myminio ALIAS 上 mydata 存储桶中具有 meetingnotes/ 前缀的对象，在 90 天后过期。

--tags

mc-cmd

Optional

一个或多个以 & 分隔的键值对，用于描述对象标签，以筛选生命周期配置规则适用的对象。

此选项与以下选项互斥：

• --expire-delete-marker

--expire-all-object-versions

mc-cmd

Optional

使对象的当前版本和非当前版本全部过期。 与 --expire-days 选项结合使用，以指定扫描器进程在多少天后删除对象的所有版本。

在 scanner 处理该命令后，部署中将不再保留该对象的任何版本。

此标志 仅 适用于最新版本 不是 删除标记的对象。

--expire-days

mc-cmd

Optional

对象创建后保留的天数。 达到指定天数后，MinIO 会将对象标记为待删除。 使用整数指定天数，例如 30 表示 30 天。

对于启用版本控制的存储桶，过期规则仅适用于对象的 当前 版本。 使用 --noncurrent-expire-days 或 --expire-all-object-versions 标志，可将过期行为应用于对象的非当前版本。

MinIO 使用 scanner process 根据所有已配置的生命周期管理规则检查对象。 在高 IO 负载或系统资源受限时，扫描变慢可能导致生命周期管理规则应用延迟。 更多信息请参见 生命周期管理对象扫描器。

与以下选项互斥：

• --expire-delete-marker

关于对象过期的完整文档，请参见 对象过期 和 对象删除。

--expire-delete-marker

mc-cmd

Optional

指定该选项后，MinIO 会移除没有剩余对象版本的对象删除标记。 具体来说，删除标记是该对象唯一剩余的“版本”。

此选项与以下选项互斥：

• --tags
• --expire-days

MinIO 使用 scanner process 根据所有已配置的生命周期管理规则检查对象。 在高 IO 负载或系统资源受限时，扫描变慢可能导致生命周期管理规则应用延迟。 更多信息请参见 生命周期管理对象扫描器。

关于对象过期的完整文档，请参见 对象过期 和 对象删除。

--transition-days

mc-cmd

Optional

对象创建后经过多少个日历日，MinIO 将对象标记为可迁移。 MinIO 会将对象迁移到由 --transition-tier 指定的远程层。 使用整数指定天数，例如 30 表示 30 天。 如果远程层是另一个 MinIO 部署，可将该值设为 0，使新对象立即具备迁移到远程层的资格。

对于启用版本控制的存储桶，迁移规则仅适用于对象的 当前 版本。 使用 --noncurrent-transition-days 选项可将迁移行为应用于对象的非当前版本。

需要同时指定 --transition-tier。

MinIO 使用 scanner process 根据所有已配置的生命周期管理规则检查对象。 在高 IO 负载或系统资源受限时，扫描变慢可能导致生命周期管理规则应用延迟。 更多信息请参见 生命周期管理对象扫描器。

关于对象迁移的完整文档，请参见 对象迁移（”Tiering”）。

--transition-tier

mc-cmd

Optional

MinIO transition objects 的目标远程层。 指定由 mc ilm tier add 创建的现有远程层。

当指定 --transition-days 时，此项为必需。

--noncurrent-expire-days

mc-cmd

Optional

对象版本变为 非当前 后（即该对象已有其他版本成为 HEAD）保留的天数。 达到指定天数后，MinIO 会将非当前对象版本标记为待删除。

此选项与 S3 NoncurrentVersionExpiration 操作行为一致。

MinIO 使用 scanner process 根据所有已配置的生命周期管理规则检查对象。 在高 IO 负载或系统资源受限时，扫描变慢可能导致生命周期管理规则应用延迟。 更多信息请参见 生命周期管理对象扫描器。

--noncurrent-transition-days

mc-cmd

Optional

对象在成为非当前版本后（即被同一对象的更新版本替换）经过多少天，MinIO 将该对象版本标记为可迁移。 当系统主机日期时间超过该日历日期时，MinIO 会将对象迁移到 --transition-tier 指定的远程层。

此选项对非版本化存储桶无效。 需要同时指定 --noncurrent-transition-tier。

此选项与 S3 NoncurrentVersionTransition 操作行为一致。

MinIO 使用 scanner process 根据所有已配置的生命周期管理规则检查对象。 在高 IO 负载或系统资源受限时，扫描变慢可能导致生命周期管理规则应用延迟。 更多信息请参见 生命周期管理对象扫描器。

--noncurrent-transition-tier

mc-cmd

Optional

MinIO transitions noncurrent objects versions 的目标远程层。 指定由 mc ilm tier add 创建的远程层。

--noncurrent-expire-newer

mc-cmd

Optional

要保留的非当前对象版本最大数量，按从新到旧排序。

使用此标志可按先进先出方式保留文件的一定数量历史版本。 在保留达到最大非当前版本数后，MinIO 会将其余更旧的非当前对象版本标记为可过期。

下表基于 --noncurrent-expire-newer 3 展示对象版本数量及其过期资格：

MinIO 会保留当前版本 v5。 MinIO 还会从最新版本开始，保留接下来的 3 个非当前版本。 这意味着 MinIO 会将 v4、v3 和 v2 作为要保留的三个非当前版本。

v1 是第四个非当前版本，超出非当前版本保留上限，因此 MinIO 会将 v1 标记为过期。

更新此标志的数值只会影响尚未标记的对象版本。 对于已标记为过期的版本，即使增加保留数量也不会改变。

MinIO 使用 scanner process 根据所有已配置的生命周期管理规则检查对象。 在高 IO 负载或系统资源受限时，扫描变慢可能导致生命周期管理规则应用延迟。 更多信息请参见 生命周期管理对象扫描器。

--size-gt

mc-cmd

Optional

选择大于指定值的对象。 以数字加单位输入该值，例如 5GiB 表示 5 gibibytes。

有效单位包括：

--size-lt

mc-cmd

Optional

选择小于指定值的对象。 以数字加单位输入该值，例如 1M 表示 1 megabyte。

有效单位包括：

全局标志

此命令支持 全局标志 中的任意选项。

示例

在指定天数后过期存储桶全部内容

将 mc ilm rule add 与 --expire-all-object-versions 和 --expire-days 标志配合使用，可在对象创建后经过指定天数后，将存储桶中的所有当前版本和非当前版本内容标记为过期：

mc ilm rule add ALIAS/PATH --expire-all-object-versions --expire-days "DAYS"

• 将 ALIAS 替换为 S3 兼容主机的 alias。
• 将 PATH 替换为 S3 兼容主机上存储桶的路径。
• 将 DAYS 替换为每个对象过期前的天数。 例如，指定 30 表示对象在创建 30 天后过期。

将某前缀下的非当前对象版本迁移到不同层

将 mc ilm rule add 与 --prefix 和 --transition-tier 配合使用，可将对象较旧的非当前版本迁移到不同存储层。

mc ilm rule add --prefix "doc/" --transition-days "90" --transition-tier "MINIOTIER-1"  \
       --noncurrent-transition-days "45" --noncurrent-transition-tier "MINIOTIER-2"    \
       myminio/mybucket

该命令会检查 myminio 部署上 mybucket 存储桶中前缀为 doc/ 的内容。

• 前缀下超过 90 天的当前对象会移动到 MINIOTIER-1 存储层。
• 前缀下超过 45 天的非当前对象会移动到 MINIOTIER-2 存储层。
• MINIOTIER-1 和 MINIOTIER-2 均已通过 mc admin tier add 创建。

让某前缀下所有对象过期，并让当前版本比非当前版本保留更久

将 mc ilm rule add 命令与 --prefix、--expire-days 和 --noncurrent-expire-days 配合使用，可让对象的当前版本与非当前版本在不同时间过期。

mc ilm rule add --prefix "doc/" --expire-days "300" --noncurrent-expire-days "100" myminio/mybucket

该命令会检查 myminio 部署上 mybucket 存储桶中前缀为 doc/ 的内容。

• 当前对象在 300 天后过期。
• 非当前对象在 100 天后过期。

迁移前缀 /doc 下大于 1MiB 的非当前版本

将 mc ilm rule add 命令与 --prefix、--size-gt 和 --noncurrent-expire-days 配合使用，可让对象的当前版本与非当前版本在不同时间过期。

mc ilm rule add --prefix "doc/" --size-gt 1MiB --transition-days "90" --transition-tier "MINIOTIER-1" \
      --noncurrent-transition-days "45" --noncurrent-transition-tier "MINIOTIER-1" \
      myminio/mybucket/

该命令会检查 myminio 部署上 mybucket 存储桶中前缀为 doc/ 的内容。

该命令会选择以下对象：

• 大于 1MiB 且超过 90 天的当前对象。
• 大于 1MiB 且超过 45 天的非当前对象。

所选对象会迁移到 MINIOTIER-1。

移除删除标记

以下命令会移除删除标记仅为对象唯一剩余版本的对象的删除标记。

mc ilm rule add ALIAS/PATH --expire-delete-marker

• 将 ALIAS 替换为 S3 兼容主机的 alias。
• 将 PATH 替换为 S3 兼容主机上存储桶的路径。

所需权限

有关添加规则所需权限，请参见父命令中的 required permissions。

行为

生命周期管理对象扫描器

MinIO 使用 scanner process 根据所有已配置的 生命周期管理规则检查对象。在高 IO 负载或 系统资源受限时，扫描变慢可能导致生命周期管理 规则应用延迟。更多信息请参见 生命周期管理对象扫描器。

过期与迁移

MinIO 支持在同一个存储桶或存储桶前缀中同时指定过期和迁移规则。 无论对象的迁移状态如何，MinIO 都可以对其执行过期规则。 使用 mc ilm rule ls 查看当前已配置的对象生命周期 管理规则，以评估过期与迁移规则之间可能的相互影响。

S3 兼容性

mc 命令行工具以兼容 AWS S3 API 为目标构建，并针对 MinIO 和 AWS S3 进行了测试，以验证预期的功能与行为。

对于其他 S3 兼容服务，MinIO 不提供任何保证，因为这些服务的 S3 API 实现未知， 因此不在支持范围内。虽然 mc 命令 可能 仍能按文档说明工作，但此类 用法需要你自行承担风险。

11 - mc ilm tier add

描述

mc ilm tier add 命令在受支持的存储服务上创建一个新的远程存储层。

完整列表请参见 对象转换。

支持的 S3 服务

mc ilm tier add 仅 支持以下 S3 兼容服务作为对象分层的远程目标：

• MinIO
• Amazon S3
• Google Cloud Storage
• Azure Blob Storage

权限

在为对象转换生命周期管理规则创建远程层的集群上，MinIO 需要以下管理权限：

• admin:SetTier
• admin:ListTier

例如，以下策略授予在集群中任意存储桶上配置对象转换生命周期管理规则的权限：

{
   "Version": "2012-10-17",
   "Statement": [
      {
            "Action": [
               "admin:SetTier",
               "admin:ListTier"
            ],
            "Effect": "Allow",
            "Sid": "EnableRemoteTierManagement"
      },
      {
            "Action": [
               "s3:PutLifecycleConfiguration",
               "s3:GetLifecycleConfiguration"
            ],
            "Resource": [
                        "arn:aws:s3:::*"
            ],
            "Effect": "Allow",
            "Sid": "EnableLifecycleManagementRules"
      }
   ]
}

语法

 mc ilm tier add minio myminio WARM-MINIO-TIER                     \
                               --endpoint https://warm-minio.com   \
                               --access-key ACCESSKEY              \
                               --secret-key SECRETKEY              \
                               --bucket mybucket                   \
                               --prefix myprefix/

mc ilm tier add TIER_TYPE                    \
                TARGET                       \
                TIER_NAME                    \
                --bucket value               \
                [--endpoint string]          \
                [--region string]            \
                [--access-key value^]        \
                [--secret-key value^]        \
                [--use-aws-role^]            \
                [--aws-role-arn^]            \
                [--aws-web-identity-file^]   \
                [--azure-sp-tenant-id^]      \
                [--azure-sp-client-id^]      \
                [--azure-sp-client-secret^]  \
                [--account-name value^]      \
                [--account-key value^]       \
                [--credentials-file value^]  \
                [--prefix value]             \
                [--storage-class value]

参数

该命令接受以下参数：

TIER_TYPE

mc-cmd

Required

MinIO 将对象转换到的云服务提供商存储后端（”Tier”）。 指定以下受支持值之一：

TARGET

mc-cmd

Required

命令在该已配置 MinIO 部署的 alias 上创建新的远程层。 随后你可以使用 mc ilm rule add 并指定该新远程层来创建新规则。

TIER_NAME

mc-cmd

Required

与新远程层关联的名称。 该名称 必须 在 MinIO 集群所有已配置层中唯一。

你 必须 使用全大写指定 tier，例如 WARM_TIER。

--endpoint

mc-cmd

Optional

S3 或 MinIO 存储的 URL endpoint。 URL endpoint 必须 解析到 TIER_TYPE 指定的提供方。

对 s3 或 minio tier 类型为必需，对 azure 为可选。 对 TIER_TYPE 的任何其他取值，该选项均无效。

--access-key

mc-cmd

Optional

远程 S3 或 minio tier 类型中某个用户的 access key。 该用户必须具有对远程存储桶或存储桶前缀执行 read/write/list/delete 操作的权限。

当 TIER_TYPE 为 s3 或 minio 时必需。 对 TIER_TYPE 的任何其他取值，该选项均无效。

--secret-key

mc-cmd

Optional

远程 s3 或 minio tier 类型中某个用户的 secret key。

当 TIER_TYPE 为 s3 或 minio 时必需。 对 TIER_TYPE 的任何其他取值，该选项均无效。

--account-name

mc-cmd

Optional

用作远程存储资源的 Storage Account。

当 TIER_TYPE 为 azure 时必需。 对 TIER_TYPE 的任何其他取值，该选项均无效。

MinIO 不 支持更改与 Azure 远程 tier 关联的存储账户名。 Azure 存储后端绑定到存储账户，因此更改该值会更换存储后端，并导致无法访问已转换到原账户/后端的任何对象。

--account-key

mc-cmd

Optional

与远程 Azure tier 关联的 --account-name 对应的共享 account key。

该 account key 必须绑定具备所需 权限 的 Azure 策略。

当 TIER_TYPE 为 azure 时必需。 对 TIER_TYPE 的任何其他取值，该选项均无效。

--credentials-file

mc-cmd

Optional

远程 Google Cloud Storage tier 中用户使用的 credential file。 该用户必须具有对远程存储桶或存储桶前缀执行 read/write/list/delete 操作的权限。

当 TIER_TYPE 为 gcs 时必需。 对 TIER_TYPE 的任何其他取值，该选项均无效。

--bucket

mc-cmd

Required

MinIO 将对象转换到的远程 tier 存储桶。

对于 azure 远程 tier，该值对应 Container name

--prefix

mc-cmd

Optional

MinIO 将对象转换到指定 --bucket 的前缀路径。

省略此字段可将对象转换到存储桶根路径。

--storage-class

mc-cmd

Optional

MinIO 应用于转换到远程存储桶对象的 storage class（在 Microsoft Azure 中称为 “access tier”）。

应用于 MinIO 转换到远程存储桶对象的 storage class。 MinIO 分层行为依赖远程存储在请求后立即返回对象（毫秒到秒级）。 因此 MinIO 无法 支持需要 rehydration、等待周期或手动干预的远程存储。

选择与 TIER_TYPE 对应的选项卡，查看各层支持的值：

若省略，对象将使用远程存储桶定义的默认存储类。

--region

mc-cmd

Optional

指定 TIER_TYPE 的 S3 后端区域，例如 us-west-1。

该选项仅在 TIER_TYPE 为 s3 或 minio 时生效。 对 TIER_TYPE 的任何其他取值，该选项均无效。

--use-aws-role

mc-cmd

Optional

使用本地配置的 AWS Role 的访问权限。

该选项仅在 TIER_TYPE 为 s3 或 minio 时生效。 对 TIER_TYPE 的任何其他取值，该选项均无效。

--aws-role-arn

mc-cmd

Optional

转换对象时要使用的 AWS S3 角色名称。

该选项仅在 TIER_TYPE 为 s3 且 源端是 Amazon EKS 上的 MinIO pod 时生效。

--aws-web-identity-file

mc-cmd

Optional

指定转换对象时使用的 web identity token 文件。

该选项仅在 TIER_TYPE 为 s3 且 源端是 Amazon EKS 上的 MinIO pod 时生效。

--azure-sp-tenant-id

mc-cmd

Optional

用于登录 Azure 存储的 service principal account 的 Tenant ID。

该选项仅在 TIER_TYPE 为 azure 且使用 service principal 身份登录时生效。 对 TIER_TYPE 的任何其他取值，该选项均无效。

--azure-sp-client-id

mc-cmd

Optional

用于登录 Azure 存储的 service principal account 的 Client ID。

该选项仅在 TIER_TYPE 为 azure 且使用 service principal 身份登录时生效。 对 TIER_TYPE 的任何其他取值，该选项均无效。

--azure-sp-client-secret

mc-cmd

Optional

用于登录 Azure 存储的 service principal account 的 client secret。

该选项仅在 TIER_TYPE 为 azure 且使用 service principal 身份登录时生效。 对 TIER_TYPE 的任何其他取值，该选项均无效。

全局标志

此命令支持 全局标志 中的任意选项。

示例

配置一个 Tier 以将对象转换到 MinIO 部署

以下示例在本地部署上创建一个新层，已配置规则可使用该层将对象转换到独立的远程 MinIO 部署。

mc ilm tier add minio myminio WARM-MINIO-TIER --endpoint https://warm-minio.com \
     --access-key ACCESSKEY --secret-key SECRETKEY --bucket mybucket --prefix myprefix/

该命令在 myminio 部署上为 minio 类型远程存储创建一个名为 WARM-MINIO-TIER 的新层。

• 远程 MinIO 存储位于 https://warm-minio.com。
• 命令中包含了一个对该存储桶及前缀具备 read、write、list 和 delete 权限用户的凭据。
• 该层会将对象转换到远程 MinIO 存储上的 mybucket 存储桶与 myprefix 前缀。

配置一个 Tier 以将对象转换到 Azure Blob Storage 位置

以下示例在本地部署上创建一个新层，已配置规则可使用该层将对象转换到 Azure Blob Storage。

mc ilm tier add azure myminio AZTIER --account-name ACCOUNT-NAME --account-key ACCOUNT-KEY \
     --bucket myazurebucket --prefix myazureprefix/

该命令在 myminio 部署上为 azure 类型远程存储创建一个名为 AZTIER 的新层。

• 使用提供的 account name 和 key 访问远程 Azure 存储。
• 该层会将对象转换到 Azure 存储上的 myazurebucket 存储桶与 myazureprefix 前缀。

配置一个 Tier 以将对象转换到 Google Cloud Storage

以下示例在本地部署上创建一个新层，已配置规则可使用该层将对象转换到 Google Cloud Storage。

 mc ilm tier add gcs myminio GCSTIER --credentials-file /path/to/credentials.json \
     --bucket mygcsbucket  --prefix mygcsprefix/

该命令在 myminio 部署上为 gcs 类型远程存储创建一个名为 GCSTIER 的新层。

• 使用提供的 credentials file 访问远程 GCS 存储。
• 该层会将对象转换到 GCS 存储上的 mygcsbucket 存储桶与 mygcsprefix 前缀。

配置一个 Tier 以将对象转换到 Amazon Simple Storage Service (S3)

以下示例在本地部署上创建一个新层，已配置规则可使用该层将对象转换到 S3 上的 STANDARD 存储。

 mc ilm tier add s3 myminio S3TIER --endpoint https://s3.amazonaws.com \
     --access-key ACCESSKEY --secret-key SECRETKEY --bucket mys3bucket --prefix mys3prefix/ \
     --storage-class "STANDARD" --region us-west-2

该命令在 myminio 部署上为 s3 类型远程存储创建一个名为 S3TIER 的新层。

• S3 存储位于提供的 endpoint。
• 使用提供的 access key 和 secret key 访问远程 S3 存储。
• 该层会将对象转换到 GCS 存储上的 mys3bucket 存储桶与 mys3prefix 前缀。
• 该层使用位于 us-west-2 S3 区域的 S3 STANDARD 存储类。

S3 兼容性

mc 命令行工具以兼容 AWS S3 API 为目标构建，并针对 MinIO 和 AWS S3 进行了测试，以验证预期的功能与行为。

对于其他 S3 兼容服务，MinIO 不提供任何保证，因为这些服务的 S3 API 实现未知， 因此不在支持范围内。虽然 mc 命令 可能 仍能按文档说明工作，但此类 用法需要你自行承担风险。

所需权限

有关添加 tier 所需的权限，请参见父命令中的 required permissions。

12 - mc legalhold clear

语法

mc legalhold clear 命令会移除一个或多个对象当前的 legal hold 设置。

移除对象的 legal hold 不会 移除对象上已有的其他 GOVERNANCE 模式 和 COMPLIANCE 模式 保留设置。

mc legalhold clear --recursive myminio/mydata

mc [GLOBALFLAGS] legalhold clear \
                 [--recursive]   \
                 [--rewind]      \
                 [--version-id]  \
                 ALIAS

参数

ALIAS

mc-cmd

Required

MinIO alias 以及要移除 legal hold 的对象路径（可为单个或多个对象）。例如：

mc legalhold clear play/mybucket/myobjects/objects.txt

--recursive, r

mc-cmd

Optional

移除 ALIAS 指定存储桶或存储桶前缀下 所有对象的 legal hold。

--rewind

mc-cmd

Optional

指示 mc legalhold clear 仅对指定时间点存在的对象版本执行操作。

• 如需回溯到过去的特定日期，请将该日期指定为 ISO8601 格式的时间戳。 例如：--rewind "2020.03.24T10:00"。
• 如需按时间长度回溯，请将该时长指定为 #d#hh#mm#ss 格式的字符串。 例如：--rewind "1d2hh3mm4ss"。

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

--version-id, vid

mc-cmd

Optional

指示 mc legalhold clear 仅对指定的对象版本执行操作。

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

全局标志

此命令支持 全局标志 中的任意选项。

示例

获取对象的 Legal Hold 状态

使用 mc legalhold clear 获取对象的 legal hold 状态。 包含 --recursive 可返回存储桶内容的 legal hold 状态：

mc legalhold clear [--recursive] ALIAS/PATH

• 将 ALIAS 替换为 S3 兼容主机的 alias。
• 将 PATH 替换为 S3 兼容主机上的 存储桶或对象路径。若指定的是存储桶或存储桶前缀路径，请包含 --recursive 选项。

行为

S3 兼容性

mc 命令行工具以兼容 AWS S3 API 为目标构建，并针对 MinIO 和 AWS S3 进行了测试，以验证预期的功能与行为。

对于其他 S3 兼容服务，MinIO 不提供任何保证，因为这些服务的 S3 API 实现未知， 因此不在支持范围内。虽然 mc 命令 可能 仍能按文档说明工作，但此类 用法需要你自行承担风险。

13 - mc license info

描述

mc license info 命令用于显示 MinIO 部署的许可证状态信息。 具体来说，用于确认该部署使用的是 AGPLv3 开源许可证，还是 MinIO Commercial License。

你必须在 MinIO MinIO SUBNET 中注册部署，才能激活商业许可证。

例如，对于未注册的部署，该命令会返回以下信息：

You are using GNU AFFERO GENERAL PUBLIC LICENSE Version 3 (https://www.gnu.org/licenses/agpl-3.0.txt)

If you are building proprietary applications, you may want to choose the commercial license
included as part of the Standard and Enterprise subscription plans. (https://min.io/signup?ref=mc)

Applications must otherwise comply with all the GNU AGPLv3 License & Trademark obligations.

使用 mc license register 将你的部署关联到 SUBNET 账户。 如果你尚未注册 SUBNET，请参阅 Registration 页面。

示例

显示别名为 minio1 的部署当前许可证

mc license info minio1

如果部署使用的是已过期的 MinIO Commercial License，该命令会输出错误信息。

语法

该命令的语法如下：

mc [GLOBALFLAGS] license info       \
                         ALIAS      \
                         [--airgap]

参数

ALIAS

mc-cmd

Required

MinIO 部署的 alias。

--airgap

mc-cmd

Optional

在运行 minio client 的客户端机器无法通过网络访问 SUBNET 的环境中使用（例如 airgapped、受防火墙限制或类似配置），以显示如何将部署注册到 SUBNET 的说明。

如果部署处于 airgapped 环境，但本地设备具备网络访问能力，则无需使用 --airgap 标志。

全局选项

此命令支持 全局标志 中的任意选项。

14 - mc replicate add

语法

mc replicate add 命令会为 MinIO 部署中的存储桶创建一条新的 服务端复制 规则。

远程存储桶 必须 位于与本地部署运行相同 MinIO 版本的 MinIO 部署上。

创建规则后，MinIO 部署会自动开始将新对象同步到远程 MinIO 部署。 你也可以选择配置对现有对象、删除操作和已完全删除对象的同步。

mc replicate add                                                     \
   --remote-bucket https://user:[email protected]:9001/bucket  \
   --replicate "delete,delete-marker,existing-objects"               \
   myminio/mydata

mc [GLOBALFLAGS] replicate add                     \
                 --remote-bucket string          \
                 [--bandwidth "string"]            \
                 [--disable]                       \
                 [--disable-proxy]                 \
                 [--healthcheck-seconds integer]   \
                 [--id "string"]                   \
                 [--limit-upload "string"]         \
                 [--limit-download "string"]       \
                 [--path "string"]                 \
                 [--region "string"]               \
                 [--replicate "string"]            \
                 [--storage-class "string"]        \
                 [--sync]                          \
                 [--tags "string"]                 \
                 [--priority int]                  \
                 ALIAS

参数

ALIAS

mc-cmd

Required

MinIO 部署的 alias，以及要在其上创建复制规则的存储桶或存储桶前缀的完整路径。 例如：

mc replicate add --remote-bucket https://user:[email protected]:9001/bucket play/mybucket

--remote-bucket

mc-cmd

Required

指定远程位置的凭证、目标部署和存储桶。 该值可以是 IP 地址、URL 或 alias/bucket。

例如，基于 URL 的目标可能如下所示：

https://user:[email protected]:9001/bucket

基于 alias 的目标可能如下所示：

--remote-bucket minio-target/my-bucket

--bandwidth

mc-cmd

Optional

将带宽速率限制为不超过指定值，单位可为 KiB/s、MiB/s 或 GiB/s。 有效单位包括：

• B 表示 bytes
• K 表示 kilobytes
• G 表示 gigabytes
• T 表示 terabytes
• Ki 表示 kibibytes
• Gi 表示 gibibytes
• Ti 表示 tebibytes

例如，要将带宽速率限制为不超过 1 GiB/s，可使用以下参数：

--limit-upload 1Gi

若未指定，MinIO 不会限制带宽速率。

--disable

mc-cmd

Optional

以“disabled”状态创建复制规则。 在使用 mc replicate update 将其启用之前，MinIO 不会按该规则开始复制对象。

在复制禁用期间创建的对象，在启用规则后不会立即具备复制资格。 你必须在传给 mc replicate update --replicate 的复制功能列表中包含 "existing-objects"，以显式启用现有对象复制。 更多信息请参见 现有对象的复制。

--disable-proxy

mc-cmd

Optional

在定义存储桶之间的 active-active 复制时，不使用代理。

默认情况下，MinIO 使用代理。

--healthcheck-seconds

mc-cmd

Optional

两次远程存储桶健康检查之间的时间间隔（秒）。

若未指定，MinIO 使用 60 秒间隔。

--id

mc-cmd

Optional

为复制规则指定唯一 ID。 如果未指定，MinIO 会自动生成一个 ID。

--limit-download

mc-cmd

Optional

将下载速率限制为不超过指定值，单位可为 KiB/s、MiB/s 或 GiB/s。 有效单位包括：

• B 表示 bytes
• K 表示 kilobytes
• G 表示 gigabytes
• T 表示 terabytes
• Ki 表示 kibibytes
• Gi 表示 gibibytes
• Ti 表示 tebibytes

例如，要将下载速率限制为不超过 1 GiB/s，可使用以下参数：

--limit-download 1G

若未指定，MinIO 使用不限速的下载速率。

--limit-upload

mc-cmd

Optional

将上传速率限制为不超过指定值，单位可为 KiB/s、MiB/s 或 GiB/s。 有效单位包括：

• B 表示 bytes
• K 表示 kilobytes
• G 表示 gigabytes
• T 表示 terabytes
• Ki 表示 kibibytes
• Gi 表示 gibibytes
• Ti 表示 tebibytes

例如，要将上传速率限制为不超过 1 GiB/s，可使用以下参数：

--limit-upload 1G

若未指定，MinIO 使用不限速的上传速率。

--path

mc-cmd

Optional

为远程存储桶启用 path-style 查找支持。

有效值包括：

• on - 使用路径查找来定位远程存储桶
• off - 使用资源定位符风格（如域名或 IP 地址）查找来定位远程存储桶
• auto - 由 MinIO 自动识别用于定位远程存储桶的正确查找类型

未定义时，MinIO 使用 auto 值。

--priority

mc-cmd

Optional

指定复制规则的整数优先级。 该值 必须 在源存储桶的所有其他规则中保持唯一。 值越高表示优先级 越高。

默认值为 0。

--region

mc-cmd

Optional

要将内容复制到的目标存储桶区域。

--replicate

mc-cmd

Optional

指定一个由逗号分隔的值列表，以启用扩展复制功能。

• delete - 指示 MinIO 将 DELETE 操作 复制到目标存储桶。

• delete-marker - 指示 MinIO 将删除标记复制到目标存储桶。

• existing-objects - 指示 MinIO 复制在启用复制前创建的对象，或在复制暂停期间创建的对象。

• metadata-sync - 指示 MinIO 为每个对象复制元数据。 仅适用于 active-active 复制场景。

  省略此值会使 MinIO 停止将仅元数据变更回传到源端。

若未指定，MinIO 会同步所有选项。

--storage-class

mc-cmd

Optional

指定应用到复制对象上的 MinIO storage class。

--sync

mc-cmd

Optional

为该远程目标启用同步复制。

默认情况下，MinIO 使用异步复制。

--tags

mc-cmd

Optional

指定一个或多个以和号 & 分隔的键值对标签，MinIO 用其筛选要复制的对象。 例如：

mc replicate add --tags "TAG1=VALUE&TAG2=VALUE&TAG3=VALUE" ALIAS

MinIO 会将复制规则应用到标签集合 包含指定复制标签的任何对象。

全局参数

此命令支持 全局标志 中的任意选项。

示例

配置存储桶复制

以下 mc replicate add 命令会创建一个复制配置，将所有新对象、现有对象、删除操作和删除标记同步到远程目标：

mc replicate add myminio/mybucket \
   --remote-bucket https://user:[email protected]/remotebucket \
   --replicate "delete,delete-marker,existing-objects"

• 将 myminio/mybucket 替换为 ALIAS 及要创建复制配置的完整存储桶路径。
• 将 --remote-bucket 的值替换为远程目标的 URL 或路径。 如果使用文件路径格式的位置，请使用 --path on 选项。
• --replicate 参数会指示 MinIO 将所有删除操作、删除标记和现有对象复制到远程端。 关于复制行为的更多信息，请参见 删除操作的复制 和 现有对象的复制。

为历史数据记录配置存储桶复制

以下 mc replicate add 命令会创建一个新的存储桶复制配置，将所有新对象和现有对象同步到远程目标：

mc replicate add myminio/mybucket \
   --remote-bucket https://user:[email protected]/remotebucket \
   --replicate "existing-objects"

• 将 myminio/mybucket 替换为 ALIAS 及要创建复制配置的完整存储桶路径。
• 将 --remote-bucket 的值替换为远程目标的位置。 如果使用文件路径格式的位置，请使用 --path on 选项。
• --replicate 参数会指示 MinIO 将所有现有对象复制到远程端。 关于复制行为的更多信息，请参见 现有对象的复制。

生成的远程副本表示远程端对象的历史记录，源端的删除操作不会影响该远程副本。

行为

服务端复制要求源端和目标端均为 MinIO

MinIO 服务端复制仅适用于 MinIO 部署之间。 源端和目标端部署都 必须 运行 MinIO。

若要在任意兼容 S3 的服务之间配置复制，请使用 mc mirror。

在源存储桶和目标存储桶上启用版本控制

MinIO 依赖版本控制提供的不可变性保护，在源端与复制目标之间同步对象。

在开始此流程前，使用 mc version enable 命令在源存储桶和目标存储桶 两端 启用版本控制：

mc version enable ALIAS/PATH

• 将 ALIAS 替换为 MinIO 部署的 alias。
• 将 PATH 替换为要启用版本控制的存储桶。

所需权限

MinIO 强烈建议专门创建用于支持存储桶复制操作的用户。 关于向 MinIO 部署添加用户和策略的更完整文档，请参见 mc admin user 和 mc admin policy。

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Action": [
                "admin:SetBucketTarget",
                "admin:GetBucketTarget",
                "admin:ListBatchJobs",
                "admin:DescribeBatchJob",
                "admin:StartBatchJob",
                "admin:CancelBatchJob"
            ],
            "Effect": "Allow",
            "Sid": "EnableRemoteBucketConfiguration"
        },
        {
            "Effect": "Allow",
            "Action": [
                "s3:GetReplicationConfiguration",
                "s3:ListBucket",
                "s3:ListBucketMultipartUploads",
                "s3:GetBucketLocation",
                "s3:GetBucketVersioning",
                "s3:GetObjectRetention",
                "s3:GetObjectLegalHold",
                "s3:PutReplicationConfiguration"
            ],
            "Resource": [
                "arn:aws:s3:::*"
            ],
            "Sid": "EnableReplicationRuleConfiguration"
        }
    ]
}

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "s3:GetReplicationConfiguration",
                "s3:ListBucket",
                "s3:ListBucketMultipartUploads",
                "s3:GetBucketLocation",
                "s3:GetBucketVersioning",
                "s3:GetBucketObjectLockConfiguration",
                "s3:GetEncryptionConfiguration"
            ],
            "Resource": [
                "arn:aws:s3:::*"
            ],
            "Sid": "EnableReplicationOnBucket"
        },
        {
            "Effect": "Allow",
            "Action": [
                "s3:GetReplicationConfiguration",
                "s3:ReplicateTags",
                "s3:AbortMultipartUpload",
                "s3:GetObject",
                "s3:GetObjectVersion",
                "s3:GetObjectVersionTagging",
                "s3:PutObject",
                "s3:PutObjectRetention",
                "s3:PutBucketObjectLockConfiguration",
                "s3:PutObjectLegalHold",
                "s3:DeleteObject",
                "s3:ReplicateObject",
                "s3:ReplicateDelete"
            ],
            "Resource": [
                "arn:aws:s3:::*"
            ],
            "Sid": "EnableReplicatingDataIntoBucket"
        }
    ]
}

现有对象复制

从 mc RELEASE.2021-06-13T17-48-22Z 和 minio RELEASE.2021-06-07T21-40-51Z 开始，MinIO 支持自动复制存储桶中的现有对象。 MinIO 的现有对象复制实现了类似 AWS Replicating existing objects between S3 buckets 的能力，而无需联系技术支持的额外开销。

• 若要在创建新复制规则时启用现有对象复制，请在传给 mc replicate add --replicate 的复制功能列表中包含 "existing-objects"。
• 若要为已有复制规则启用现有对象复制，请使用 mc replicate add --replicate 将 "existing-objects" 添加到现有复制功能列表中。 编辑复制规则时，你必须指定 所有 期望的复制功能。

有关此行为的更完整文档，请参见 现有对象的复制。

元数据变更同步

MinIO 支持 双向 active-active 复制配置，即在两个 MinIO 部署上的存储桶之间同步新增和修改后的对象。 从 mc RELEASE.2021-05-18T03-39-44Z 开始，MinIO 默认会将复制对象的仅元数据变更同步回“源”部署。 在该更新之前，MinIO 不支持同步复制对象的仅元数据变更。

启用元数据同步后，MinIO 会重置对象的 复制状态 以表明其具备复制资格。 具体而言，当应用对状态为 REPLICA 的对象执行仅元数据更新时，MinIO 会将对象标记为 PENDING 并使其具备复制资格。

若要禁用元数据同步，请使用 mc replicate update --replicate 命令，并在复制功能列表中省略 replica-metadata-sync。

删除操作复制

MinIO 支持将删除操作复制到目标存储桶。 具体来说，MinIO 可以同时复制 Delete Markers 以及 特定版本对象的删除：

• 对对象执行删除操作时，MinIO 复制也会在目标存储桶创建删除标记。
• 对对象版本执行删除操作时，MinIO 复制也会删除目标存储桶中的对应版本。

对于因 生命周期管理过期规则 被删除的对象，MinIO 不会 进行复制。 MinIO 仅复制由客户端显式触发的删除操作。

MinIO 要求使用 mc replicate add --replicate 参数显式启用删除操作复制。 本流程包含启用删除操作和删除标记复制所需的参数。 有关此行为的更完整文档，请参见 删除操作的复制。

加密对象复制

MinIO 支持复制使用自动 Server-Side Encryption (SSE-S3) 加密的对象。 要复制加密对象，源存储桶和目标存储桶都 必须 启用自动 SSE-S3。

作为复制流程的一部分，MinIO 会在源存储桶上 解密 对象，并传输未加密对象。 目标 MinIO 部署随后会使用目标存储桶的 SSE-S3 配置重新加密该对象。 MinIO 强烈建议 在源端和目标端部署上都 启用 TLS，以确保对象在传输过程中的安全。

MinIO 不 支持复制客户端侧加密对象（SSE-C）。

S3 兼容性

mc 命令行工具以兼容 AWS S3 API 为目标构建，并针对 MinIO 和 AWS S3 进行了测试，以验证预期的功能与行为。

对于其他 S3 兼容服务，MinIO 不提供任何保证，因为这些服务的 S3 API 实现未知， 因此不在支持范围内。虽然 mc 命令 可能 仍能按文档说明工作，但此类 用法需要你自行承担风险。

15 - mc retention set

语法

mc retention set 命令用于为存储桶中的一个或多个对象配置 Write-Once Read-Many (WORM) locking 设置。 你还可以为存储桶设置默认对象锁定设置，使未显式配置对象锁定的所有对象继承该存储桶默认值。

要在 legal hold 下锁定对象， 请使用 mc legalhold set。

mc retention set 要求 指定存储桶已启用对象锁定。 你 只能 在创建存储桶时启用对象锁定。有关启用对象锁定创建存储桶的文档，请参见 mc mb --with-lock。

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

mc [GLOBALFLAGS] retention set                         \
                 [--bypass]                            \
                 [--default]                           \
                 [--recursive]                         \
                 [--rewind "string"]                   \
                 [--versions]                          \
                 [--version-id "string"]*              \
                 MODE                                  \
                 "VALIDITY"                            \
                 ALIAS

参数

MODE

mc-cmd

Required

设置 ALIAS 的锁定模式。 指定以下支持值之一：

• governance
• compliance

有关支持模式的更多信息，请参见 AWS S3 文档 Object Lock Overview。

需要指定 VALIDITY。

VALIDITY

mc-cmd

Required

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

• 按天计时，指定格式为 Nd 的字符串。例如，

  30d 表示对象创建后 30 天。

• 按年计时，指定格式为 Ny 的字符串。例如，

  1y 表示对象创建后 1 年。

ALIAS

mc-cmd

Required

需要设置对象锁定配置的对象或对象集合的完整路径。 指定 MinIO 或兼容 S3 服务的 alias 以及存储桶完整路径。 例如：

mc retention set play/mybucket/object.txt MODE VALIDITY

• 如果 ALIAS 指定的是存储桶或存储桶前缀，请包含 --recursive 以将对象锁定设置应用到 存储桶内容。
• mc retention set 默认仅应用到对象的最新版本。 使用 --version-id 或 --versions 可分别将对象锁定设置 应用于指定版本或对象的所有版本。

--bypass

mc-cmd

Optional

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

--default

mc-cmd

Optional

使用 MODE 和 VALIDITY， 为 ALIAS 指定的存储桶设置默认对象锁定设置。 在该存储桶中创建的任何对象都会继承默认对象锁定设置， 除非使用 mc retention set 显式覆盖。

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

--recursive, --r

mc-cmd

Optional

递归将对象锁定设置应用到 ALIAS 路径下的所有对象。

与 --version-id 互斥。

--rewind

mc-cmd

Optional

指示 mc retention set 仅对指定时间点存在的对象版本执行操作。

• 如需回溯到过去的特定日期，请将该日期指定为 ISO8601 格式的时间戳。 例如：--rewind "2020.03.24T10:00"。
• 如需按时间长度回溯，请将该时长指定为 #d#hh#mm#ss 格式的字符串。 例如：--rewind "1d2hh3mm4ss"。

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

--version-id, --vid

mc-cmd

Optional

指示 mc retention set 仅对指定的对象版本执行操作。

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

与以下任一标志互斥：

• --versions
• --rewind
• --recursive

--versions

mc-cmd

Optional

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

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

将 --versions 与 --rewind 结合使用， 可将保留设置应用到特定时间点存在的所有对象版本。

全局标志

此命令支持 全局标志 中的任意选项。

示例

设置存储桶默认保留设置

将 mc retention set 与 --recursive 和 --default 结合使用， 以设置存储桶默认保留设置。

mc retention set  --recursive --default MODE DURATION ALIAS/PATH

• 将 MODE 替换为要启用的保留模式。 MinIO 支持 AWS S3 保留模式 governance 和 compliance。
• 将 DURATION 替换为对象锁定应持续生效的时长。 例如，要将保留期设置为 30 天，请指定 30d。
• 将 ALIAS 替换为已配置的兼容 S3 主机的 alias。
• 将 PATH 替换为存储桶路径。

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

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

mc retention set --version-id VERSION MODE DURATION ALIAS/PATH

mc retention set --versions  MODE DURATION ALIAS/PATH

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

行为

对象版本的保留

对于启用了 versioning 的存储桶，mc retention set 默认对目标对象（一个或多个）的 最新 版本执行操作。 mc retention set 包含若干特定选项，在 显式 指定时， 可指示命令对特定对象版本 或 对象的所有版本执行操作：

与 legal hold 的交互

锁定对象会阻止对该对象进行任何修改或删除， 与 COMPLIANCE 对象锁定模式类似。 对象可以同时具有基于保留的锁和 legal hold 锁。

legal hold 锁会 覆盖 任何保留锁定，这意味着处于 legal hold 下的对象 即使保留期到期也会保持锁定。对处于 legal hold 下对象的保留设置进行设置、 修改或清除，在 legal hold 到期或被显式禁用之前均不会生效。

有关对象 legal hold 的更多信息，请参见 mc legalhold。

S3 兼容性

mc 命令行工具以兼容 AWS S3 API 为目标构建，并针对 MinIO 和 AWS S3 进行了测试，以验证预期的功能与行为。

对于其他 S3 兼容服务，MinIO 不提供任何保证，因为这些服务的 S3 API 实现未知， 因此不在支持范围内。虽然 mc 命令 可能 仍能按文档说明工作，但此类 用法需要你自行承担风险。

16 - mc share download

语法

mc share download 命令会生成一个临时的预签名 URL，并集成访问凭证， 用于从 MinIO 存储桶下载对象。该临时 URL 会在可配置的时间限制后过期。

• 应用程序可以通过执行 GET 从该 URL 获取对象。
• 用户可以在浏览器中打开该 URL 下载对象。

有关可共享对象 URL 的更多信息，请参阅 Amazon S3 关于 Pre-Signed URLs.

mc share download --recursive myminio/mydata

mc [GLOBALFLAGS] share download           \
                 [--expire "string"]      \
                 [--recursive]            \
                 [--version-id "string"]  \
                 ALIAS

参数

ALIAS

mc-cmd

Required

MinIO 部署的 alias，以及要为其生成下载 URL 的对象完整路径。例如：

mc share download play/mybucket/object.txt

你可以在同一个或不同的 MinIO 部署上指定多个对象。例如：

mc share download play/mybucket/object.txt play/mybucket/otherobject.txt

如果指定的是存储桶路径或存储桶前缀路径，则 必须 同时指定 --recursive 参数。例如：

mc share download --recursive play/mybucket/

mc share download --recursive play/mybucket/myprefix/

--expire, E

mc-cmd

Optional

为所有生成的 URL 设置过期时间限制。

指定一个格式为 ##h##m##s 的字符串。例如：12h34m56s 表示 URL 生成后 12 小时 34 分 56 秒过期。

默认为 168h，即 168 小时（7 天）。

--recursive, r

mc-cmd

Optional

递归地为 mc share download ALIAS 存储桶或存储桶前缀中的所有对象生成 URL。

如果任一 ALIAS 指向存储桶路径或存储桶前缀路径，则此参数为必需。

--version-id, vid

mc-cmd

Optional

指示 mc share download 仅对指定的对象版本执行操作。

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

全局标志

此命令支持 全局标志 中的任意选项。

示例

生成用于下载对象的 URL

mc share download --expire DURATION ALIAS/PATH

mc share download --recursive --expire DURATION ALIAS/PATH

行为

S3 兼容性

mc 命令行工具以兼容 AWS S3 API 为目标构建，并针对 MinIO 和 AWS S3 进行了测试，以验证预期的功能与行为。

对于其他 S3 兼容服务，MinIO 不提供任何保证，因为这些服务的 S3 API 实现未知， 因此不在支持范围内。虽然 mc 命令 可能 仍能按文档说明工作，但此类 用法需要你自行承担风险。

17 - mc support callhome

描述

mc support callhome 命令用于启用或禁用将部署诊断信息发送到 MinIO SUBNET。

所有 mc support 命令都需要有效的 SUBNET 订阅。

启用后，MinIO 会将诊断信息发送到 SUBNET。

无论注册状态如何，MinIO 默认禁用此功能。 你必须显式启用 callhome 功能，信息上传才会开始。

语法

mc support callhome enable

mc-cmd

开始将部署的诊断信息、日志或两者同时发送到 SUBNET。

mc support callhome enable    \
                    ALIAS     \
                    [--logs]  \
                    [--diag]

mc support callhome disable

mc-cmd

停止将部署的诊断信息、日志或两者同时发送到 SUBNET。

mc support callhome disable  \
                    ALIAS    \
                    [--logs] \
                    [--diag]

mc support callhome status

mc-cmd

输出某个部署当前是否将诊断信息、日志或两者同时发送到 SUBNET。

mc support callhome status   \
                    ALIAS    \
                    [--diag]

参数

ALIAS

mc-cmd

Required

MinIO 部署的 alias。

--diag

mc-cmd

Optional

每 24 小时向 SUBNET 发送部署诊断信息，或停止发送。

示例

启用 callhome 上报

为已注册到 SUBNET 且 alias 为 minio1 的部署启用向 SUBNET 发送诊断信息。

mc support callhome enable minio1

禁用 callhome 上报

为已注册到 SUBNET 且 alias 为 minio1 的部署禁用向 SUBNET 发送诊断信息。

mc support callhome disable minio1

显示当前 callhome 设置

显示别名为 minio1 的部署是否向 SUBNET 发送信息。

mc support callhome status minio1

全局标志

此命令支持 全局标志 中的任意选项。

18 - mc support top api

语法

mc support top api 命令用于汇总 MinIO 部署服务器上的实时 API 事件。

mc support top api myminio/

mc [GLOBALFLAGS] support top api    \
                 TARGET             \
                 [--name "string"]  \
                 [--path "string"]  \
                 [--node "string"]  \
                 [--errors, -e]

参数

TARGET

mc-cmd

Required

命令应在其上运行的 alias、前缀或对象完整路径。 该路径至少必须包含一个 ALIAS。

--name

mc-cmd

Optional

输出与输入字符串匹配的当前 API 调用摘要。

--path

mc-cmd

Optional

输出指定路径的当前 API 调用摘要。

--node

mc-cmd

Optional

输出匹配服务器上的当前 API 调用摘要。

--errors, -e

mc-cmd

Optional

输出返回错误的当前 API 调用摘要。

全局参数

此命令支持 全局标志 中的任意选项。

示例

显示当前所有正在进行的 S3 API 调用

以下命令显示 myminio 部署中所有正在进行的 S3 API 调用：

mc support top api myminio/

显示当前正在进行的 s3.PutObject 调用

以下命令显示 myminio 部署中所有正在进行的 s3.PutObject 调用：

mc support top api --name s3.PutObject myminio/

19 - mc tag set

语法

mc tag set 命令可为存储桶或对象设置一个或多个标签。

MinIO 支持为对象最多添加 10 个自定义标签。

mc tag set myminio/mydata "tag1=value1&tag2=value2"

mc [GLOBALFLAGS] tag set                   \
                 [--rewind "string"]       \
                 [--versions]              \
                 [--version-id "string"]*  \
                 ALIAS                     \
                 "TAGS"

参数

ALIAS

mc-cmd

Required

MinIO 部署的 alias，以及要应用标签的对象完整路径（例如存储桶和对象路径）。例如：

mc tag set myminio/mybucket/object.txt

TAGS

mc-cmd

Required

使用与号（&）分隔的键值对（KEY=VALUE）列表，其中每一对表示要分配给对象的一个标签。例如：

mc tag set myminio/mybucket/object.txt "key1=value1&key2=value2"

--exclude-folders

mc-cmd

Optional

与 --recursive 一起使用时，mc tag set 将 不会 遍历子前缀。 标签仅应用于指定路径下的对象。 需要 --recursive。

以下示例将 destination=international 标签应用到 vacation-photos/cancun/ 下的对象，但不应用到 vacation-photos/cancun/ocean/ 或其他前缀。

例如，上述命令会将标签添加到 vacation-photos/cancun/pretty-beach.jpg，但不会添加到 vacation-photos/cancun/ocean/tropical-fish.jpg。

mc tag set myminio/vacation-photos/cancun "destination=international" --exclude-folders --recursive

--recursive, r

mc-cmd

Optional

递归地将标签应用到 ALIAS 指定路径下的所有对象。

--rewind

mc-cmd

Optional

指示 mc tag set 仅对指定时间点存在的对象版本执行操作。

• 如需回溯到过去的特定日期，请将该日期指定为 ISO8601 格式的时间戳。 例如：--rewind "2020.03.24T10:00"。
• 如需按时间长度回溯，请将该时长指定为 #d#hh#mm#ss 格式的字符串。 例如：--rewind "1d2hh3mm4ss"。

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

--versions

mc-cmd

Optional

指示 mc tag set 对存储桶中存在的所有对象版本执行操作。

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

将 --versions 与 --rewind 一起使用，可将标签应用到某个特定时间点存在的所有对象版本。

--version-id, --vid

mc-cmd

Optional

指示 mc tag set 仅对指定的对象版本执行操作。

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

与以下参数互斥：

• --rewind
• --versions

全局标志

此命令支持 全局标志 中的任意选项。

示例

将标签应用到存储桶或对象

使用 mc tag set 将标签应用到存储桶或对象：

mc tag set ALIAS/PATH "TAGS"

• 将 ALIAS 替换为 MinIO 部署的 alias。
• 将 PATH 替换为 MinIO 部署中存储桶 或对象的路径。
• 将 TAGS 替换为一个或多个用与号分隔（&）的键值对， 每个键值对表示一个标签及其对应值。

行为

S3 兼容性

mc 命令行工具以兼容 AWS S3 API 为目标构建，并针对 MinIO 和 AWS S3 进行了测试，以验证预期的功能与行为。

对于其他 S3 兼容服务，MinIO 不提供任何保证，因为这些服务的 S3 API 实现未知， 因此不在支持范围内。虽然 mc 命令 可能 仍能按文档说明工作，但此类 用法需要你自行承担风险。

20 - mc version enable

语法

mc version enable 命令用于为指定存储桶启用版本控制。

 mc version enable myminio/mybucket

mc [GLOBALFLAGS] version enable ALIAS                \
                                --exclude-folders    \
                                --excluded-prefixes

参数

ALIAS

mc-cmd

Required

MinIO 部署的 alias 与要启用版本控制的存储桶完整路径。例如：

mc version enable myminio/mybucket

--exclude-folders

mc-cmd

Optional

在指定存储桶中，对所有文件夹（名称以 / 结尾的对象）禁用版本控制。

--excluded-prefixes

mc-cmd

Optional

对匹配前缀列表的对象禁用版本控制，最多支持 10 个前缀。 前缀列表会匹配前缀或名称中包含指定字符串的所有对象，类似 prefix* 形式的正则表达式。 如果仅按前缀匹配对象，请使用 prefix/*。

例如，以下命令将前缀或名称中包含 _test 或 _temp 的对象排除在版本控制之外：

mc version enable --excluded-prefixes "_test, _temp" myminio/mybucket

全局标志

此命令支持 全局标志 中的任意选项。

示例

启用存储桶版本控制

使用 mc version enable 为存储桶启用版本控制：

mc version enable ALIAS/PATH

• 将 ALIAS 替换为已配置 MinIO 部署的 alias。
• 将 PATH 替换为要启用版本控制的存储桶。

行为

现有数据的存储桶版本控制

在包含现有数据的存储桶上启用版本控制后，会立即为每个未版本化对象创建值为 NULL 的版本 ID。

S3 兼容性

mc 命令行工具以兼容 AWS S3 API 为目标构建，并针对 MinIO 和 AWS S3 进行了测试，以验证预期的功能与行为。

对于其他 S3 兼容服务，MinIO 不提供任何保证，因为这些服务的 S3 API 实现未知， 因此不在支持范围内。虽然 mc 命令 可能 仍能按文档说明工作，但此类 用法需要你自行承担风险。

21 - Silo 客户端设置

本页面介绍 MinIO Client 的设置。

你可以通过以下方式建立或修改设置：

• 在启动或重启 MinIO Server 之前，在宿主机系统上定义 环境变量。 如何定义环境变量，请参考所用操作系统的文档。
• 使用 mc admin config set 定义 配置项。

如果同时定义了环境变量和对应的配置项，MinIO 使用环境变量的值。

有些设置只有环境变量或配置项中的一种，而不是两者同时存在。

设置

主机凭证

使用此设置可为 mc 命令添加一个临时别名。 例如，可用于脚本场景。

该临时别名使用 AWS s3v4 signature。

示例

静态凭证

export MC_HOST_<alias>=https://<Access Key>:<Secret Key>@<YOUR-S3-ENDPOINT>

export MC_HOST_myalias=https://Q3AM3UQ867SPQQA43P2F:[email protected]

Security Token Service (STS) 凭证

export MC_HOST_<alias>=https://<Access Key>:<Secret Key>:<Session Token>@<YOUR-S3-ENDPOINT>

export MC_HOST_myalias=https://Q3AM3UQ867SPQQA43P2F:zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG:eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhY2Nlc3NLZXkiOiJOVUlCT1JaWVRWMkhHMkJNUlNYUiIsImF1ZCI6IlBvRWdYUDZ1Vk80NUlzRU5SbmdEWGo1QXU1WWEiLCJhenAiOiJQb0VnWFA2dVZPNDVJc0VOUm5nRFhqNUF1NVlhIiwiZXhwIjoxNTM0ODk2NjI5LCJpYXQiOjE1MzQ4OTMwMjksImlzcyI6Imh0dHBzOi8vbG9jYWxob3N0Ojk0NDMvb2F1dGgyL3Rva2VuIiwianRpIjoiNjY2OTZjZTctN2U1Ny00ZjU5LWI0MWQtM2E1YTMzZGZiNjA4In0.eJONnVaSVHypiXKEARSMnSKgr-2mlC2Sr4fEGJitLcJF_at3LeNdTHv0_oHsv6ZZA3zueVGgFlVXMlREgr9LXA@play.min.io

STS 服务

使用此设置可添加一个用于 mc 命令的 STS endpoint。

支持按 alias 添加多个环境变量。

export MC_STS_ENDPOINT_myalias=https://sts.minio-operator.svc.cluster.local:4223/sts/ns-1

Web Token Identity

使用此设置可添加一个用于 mc 命令的 Web Token Identity。

支持按 alias 添加多个环境变量。

export MC_WEB_IDENTITY_TOKEN_FILE_myalias=/var/run/secrets/kubernetes.io/serviceaccount/token

配置目录

指定 MinIO Client 应使用的配置目录路径。

进度条

禁用 MinIO Client 进度条。

Pager

在 CLI 中禁用 MinIO Client 的分页器功能。 使用该设置后，输出将改为直接打印到原始 STDOUT。

颜色主题

禁用 MinIO Client 输出使用的颜色主题。

JSON

启用将输出格式化为 JSON lines。

调试

启用调试输出。

禁用 SSL

禁用 SSL 证书校验。

限制下载带宽

限制 MinIO Client 在某些命令中使用的下载带宽。

若未指定，MinIO Client 使用全部可用带宽。

将客户端侧下载速率限制为不超过指定值（KiB/s、MiB/s 或 GiB/s）。该设置仅影响运行 MinIO Client 的本地设备发起的下载。支持的单位包括：

• B 表示 bytes
• K 表示 kilobytes
• M 表示 megabytes
• G 表示 gigabytes
• Ki 表示 kibibytes
• Mi 表示 mibibytes
• Gi 表示 gibibytes

例如，要将下载速率限制为不超过 1 GiB/s，可在 Linux 系统上使用以下命令：

export MC_LIMIT_DOWNLOAD=1G

在非 Linux 系统上，请参考你的操作系统文档使用等效命令。

限制上传带宽

限制 MinIO Client 在某些命令中使用的上传带宽。

若未指定，MinIO Client 使用全部可用带宽。

将客户端侧上传速率限制为不超过指定值（KiB/s、MiB/s 或 GiB/s）。该设置仅影响运行 MinIO Client 的本地设备发起的上传。支持的单位包括：

• B 表示 bytes
• K 表示 kilobytes
• M 表示 megabytes
• G 表示 gigabytes
• Ki 表示 kibibytes
• Mi 表示 mibibytes
• Gi 表示 gibibytes

例如，要将上传速率限制为不超过 1 GiB/s，可在 Linux 系统上使用以下命令：

export MC_LIMIT_UPLOAD=1G

在非 Linux 系统上，请参考你的操作系统文档使用等效命令。

SSE-KMS 加密

使用服务端管理密钥通过 SSE-KMS 对选项进行加密和解密。

SSE-S3 加密

使用服务端管理密钥通过 SSE-KMS 对选项进行加密和解密。

22 - mc alias

说明

mc alias 命令提供了一个便捷接口，用于管理 mc 可连接并执行操作的 S3 兼容主机列表。

子命令

mc alias 包含以下子命令：

23 - mc alias remove

语法

mc alias remove 从本地 mc 配置中移除一个已存在的别名。

mc alias remove myminio

mc [GLOBALFLAGS] alias remove ALIAS

参数

ALIAS

mc-cmd

必填 要从本地 mc 配置中移除的别名。