查看选项

您可以通过-h选项来查看ossfs支持的设置参数。

命令格式

./ossfs -h

您需要在ossfs程序所在目录使用该命令,默认目录为/usr/local/bin/,以实际安装环境为准。

常用选项

ossfs是基于fuse用户态文件系统来实现的,所以除了ossfs自身的选项外,也支持fuse的选项。挂载存储空间(Bucket)时,您可以根据具体的业务场景设置不同的启动选项。选项格式如下:

-o option_name[=option_value]  或者  -ooption_name[=option_value]

例如在挂载时指定uid和gid参数:

ossfs bucket_name mount_point -ourl=endpoint -ouid=uid -ogid=gid

ossfs常用选项如下:

选项名称

描述

url

用于指定存储空间的访问域名,格式为url=endpoint。当不指定具体的请求协议时,默认选择HTTP。

示例:

-ourl=oss-cn-hangzhou.aliyuncs.com
-ourl=http://oss-cn-hangzhou.aliyuncs.com
-ourl=https://oss-cn-hangzhou.aliyuncs.com

passwd_file

用于指定保存存储空间访问密钥的文件,默认为/etc/passwd-ossfs。文件的权限必须正确设置,当密钥文件为/etc/passwd-ossfs时,权限可设置为640;当密钥文件不为/etc/passwd-ossfs时,权限需要设置为600。密钥文件内容的格式为${bucket}:${access-key-id}:{access-key-secret}

示例:

#将密钥写入/etc/passwd-ossfs文件并设置640权限
echo bucket-test:LTAIbZcdVCmQ****:MOk8x0y9hxQ31coh7A5e2MZEUz**** > /etc/passwd-ossfs
chmod 640 /etc/passwd-ossfs

#将密钥写入/passwd-path/passwd-ossfs文件并设置600权限
echo bucket-test:LTAIbZcdVCmQ****:MOk8x0y9hxQ31coh7A5e2MZEUz**** > /passwd-path/passwd-ossfs
chmod 600 /passwd-path/passwd-ossfs

# 定义变量`opasswd_file`,其值为/passwd-path/passwd-ossfs
-opasswd_file=/passwd-path/passwd-ossfs

max_stat_cache_size

用于指定文件元数据的缓存空间可缓存多少个文件的元数据。单位为个,默认值为100,000。当目录下文件比较多时,可以调整这个参数,加快ls的速度。如果要禁止使用元数据缓存,可以设置为0。

ossfs bucket_name mount_point -omax_stat_cache_size=0

allow_other

赋予计算机上其他用户访问挂载目录的权限,但不包括目录内的文件。如果您要更改文件夹中的文件访问权限,请用chmod命令。该选项不需要设置选项值,如果需要启用,请直接添加-oallow_other选项。

ossfs bucket_name mount_point -ourl=endpoint -oallow_other

dbglevel

用于设置日志信息的级别,支持日志信息级别为critical、error、warn、info和debug ,默认值为critical,例如需要开启info级别的日志,请添加-odbglevel=info选项。日志信息会写到系统日志中,例如在centos系统会写到/var/log/messages中。

ossfs bucket_name mount_point -odbglevel=info

f

以前台方式而非守护进程方式运行ossfs,在前台模式下,日志会输出到终端屏幕。该参数一般用于调试问题时使用。

ossfs bucket_name mount_point -f

d

用于打开日志信息,同时该选项也会传递到fuse。在ossfs里,该选项等效于-odbglevel=info

ossfs bucket_name mount_point -d

选项列表

一般情况下,选项的格式均为-ooption_name=option_value-o option_name=option_value

说明

以下选项描述适用于ossfs 1.91.2版本及以上,其余版本部分选项可能不支持或默认参数发生变化,具体可以通过-h选项查看支持的设置参数。您可以通过进入ossfs程序所在目录执行./ossfs --version命令来查看ossfs版本。其中ossfs程序的默认目录为/usr/local/bin/,具体请以实际安装环境为准。

  • ossfs选项列表

    选项名称

    描述

    retries

    指定请求失败后的重试次数,默认值为2。

    storage_class

    指定写入OSS文件的存储类型。可选参数为:

    • Standard(默认值):标准存储

    • IA:低频访问存储

    • Archive:归档存储

    关于存储类型的更多详情请参见存储类型概述

    public_bucket

    指定用户通过匿名方式访问存储空间,该选项仅对Bucket ACL为public-read-write的存储空间有效。可选参数为:

    • 0(默认值):不使用匿名方式访问。

    • 1:使用匿名方式访问。

    passwd_file

    用于指定保存存储空间访问密钥的文件,默认为/etc/passwd-ossfs

    connect_timeout

    指定连接的超时时间,单位为秒,默认值为300秒。

    readwrite_timeout

    指定读或者写请求的超时时间,单位为秒,默认值为120秒。

    max_stat_cache_size

    指定文件元数据的缓存数量,单位为个,默认值为100,000,约额外消耗40 MB大小的空间。

    stat_cache_expire

    指定文件元数据缓存的失效时间,单位为秒,默认值为900秒。

    no_check_certificate

    对服务端的证书不做校验,仅在使用HTTPS协议时有效,默认开启证书校验。该选项无选项值,使用时请直接添加-ono_check_certificate选项。

    multireq_max

    列举文件时,访问文件元数据时的最大的并发数,默认值为20。

    parallel_count

    以分片模式上传大文件时,分片的并发数,默认值为5。

    multipart_size

    以分片模式上传数据时分片的大小,单位是MB,默认值为10。该参数会影响最大支持的文件大小。分片模式上传时,最多的分片数为10000,默认值下,最大支持的文件为100 GB。如果需要支持更大的文件,需要根据需求调整这个值。

    url

    指定存储空间的访问域名。

    umask

    用来设定挂载点内文件/文件夹的权限掩码。

    例如需要设置挂载点内文件/文件夹的权限为770,则增加-oumask=007;需要设置挂载点内文件/文件夹的权限为700,则增加-oumask=077

    enable_content_md5

    指定进行上传操作时,是否设置CONTENT_MD5,默认不设置。如果您需要设置Content-MD5,则增加-oenable_content_md5选项。

    ram_role

    使用ram_role方式访问OSS。当使用该方式访问OSS时,会忽略密钥文件的AccessKey ID和AccessKey Secret参数。

    listobjectsv2

    当Bucket开启版本控制时,建议使用-olistobjectsv2选项列举文件。

    notsup_compat_dir

    用于限制不兼容多种目录类型。默认情况下,ossfs会将dir/dir以及dir_$folder$识别为目录。

    如果您需要限制ossfs仅将dir/识别为目录,以减少ossfs与服务端的交互请求,您需要使用-onotsup_compat_dir选项。

    ensure_diskfree

    用于设置ossfs保留的可用磁盘空间大小。为提升性能,默认情况下ossfs会使用磁盘空间来保存上传或下载的临时数据。您可以通过该选项设置保留的可用硬盘空间大小,单位为MB。例如,您需要设置ossfs保留1024 MB的可用磁盘空间,则使用-oensure_diskfree=1024

    direct_read

    默认情况下ossfs会使用磁盘空间来保存上传或下载的临时数据。您可以通过设置该选项来直接从OSS读取数据而不使用本地磁盘空间。默认不设置,您可以使用-odirect_read来开启直读模式。

    说明

    当文件在直读过程中检测到用write、rename或truncate操作时,该文件会退出直读模式直至文件重新被打开。

    direct_read_chunk_size

    直读模式下指定一次读请求从OSS中读取的数据量大小,单位为MB,默认值是4。取值范围为1~32。

    该选项仅在开启直读模式,即使用-odirect_read选项时生效。

    direct_read_prefetch_thread

    直读模式下,ossfs以后台异步任务的方式来进行预读,该选项可以指定同一时间预取请求的最大线程数量,默认值是64。

    该选项仅在开启直读模式,即使用-odirect_read选项时生效。

    direct_read_prefetch_chunks

    直读模式下指定预读到内存中chunk的数量,用来提升ossfs在顺序读场景下的性能,默认值是32。

    该选项仅在开启直读模式,即使用-odirect_read选项时生效。

    direct_read_prefetch_limit

    直读模式下,ossfs通过内存来缓存从OSS中预读取的数据,通过该选项可以对ossfs预取的数据总量进行限制,单位是MB,默认值是1024。

    该选项仅在开启直读模式,即使用-odirect_read选项时生效。

    dbglevel

    设置日志信息的级别,支持日志信息级别如下:

    • critical(默认值)

    • error

    • warn

    • info

    • debug

    curldbg

    打开libcurl的日志信息,默认不打开。如果需要输出libcurl日志,则需要增加-ocurldbg选项。

  • 数据缓存选项列表

    说明

    关于数据缓存原理,具体请参见数据缓存

    选项名称

    描述

    use_cache

    启用数据缓存并指定数据缓存路径。默认不启用。您可以通过指定该选项来配置缓存路径。

    例如,您可以在挂载时添加-ouse_cache=path,则表示使用数据缓存且指定数据缓存路径为path。其中path请根据实际路径设置,例如/tmp/your_foldername。

    ensure_diskfree

    控制预留磁盘空间大小。默认不预留。您可以通过该选项设置保留的可用硬盘空间大小,避免磁盘写满影响其他应用写入,单位为MB。

    例如,您需要设置ossfs保留1024 MB的可用磁盘空间,则可以在挂载时添加-oensure_diskfree=1024

    del_cache

    控制删除本地缓存。默认不删除。您可以通过设置该选项来配置ossfs清理本地数据缓存。

    例如,您可以在挂载时添加-odel_cache选项,ossfs会在mount和umount时清理use_cache指定的文件夹下的缓存文件。

    max_dirty_data

    当写文件大小超过这个值时,不用关闭文件就会提前上传。默认值为5120 MB。

    例如,您需要设置写文件超过2000 MB就提前上传,则可以在挂载时添加-omax_dirty_data=2000

    tmpdir

    默认情况下,数据会临时缓存在系统盘/tmp目录下,您可以通过指定该选项来配置默认的临时缓存路径。该选项和use_cache选项不可同时使用。

    例如,您可以在挂载时添加-otmpdir=path,配置默认的临时数据缓存路径为path。其中path请根据实际路径设置,例如/data/your_foldername。

  • fuse选项列表

    选项名称

    描述

    allow_other

    修改挂载点的权限,允许所有的用户访问。该选择默认情况下只允许root用户设置。该选项无选项值,使用时请直接添加-oallow_other选项。

    uid

    指定文件夹归属用户的用户UID。

    gid

    指定文件夹归属用户的用户GID。