下载数据

srcdir

无

是

源路径。可以为已引用的数据，查看引用数据时，需要使用绝对路径。

destdir

无

是

目的路径。

--rename

-e

否

重命名，下载文件时可选。

--recursive

-r

否

按指定的对象名前缀批量下载，批量下载时必选。

--force

-f

否

强制操作，不进行询问提示，批量下载时可选。

--flat

-l

否

批量下载时，不包含上一级父对象名前缀，批量下载时可选。

--update

-u

否

增量下载操作，设置该参数后，下载每个文件时会比对本地的文件，仅在以下情况时下载数据：

• 文件不存在。
• 下载文件大小与本地文件大小不一致。
• 文件的最后修改时间不一致。

--parallel

-p

否

每个分段复制任务的最大并发数。

--jobs

-j

否

下载文件夹时，批量任务的最大并发数，默认为5。取值范围[1,10]。

--fr

-R

否

下载对象时生成结果清单文件。

--tempFileDir

-D

否

分段下载时保存临时文件的文件夹，默认为配置文件中的defaultTempFileDir。

如果该值为空，且配置文件中的defaultTempFileDir也为空，则分段下载时生成的临时文件会保存在待下载文件的同目录下并以.obs.temp结尾。由于分段下载时生成的临时文件会保存在该目录，请确保运行obsutil的用户对该路径有写权限。该路径的可用空间需要大于待下载对象的大小。

--dryRun

-y

否

测试模式运行，不执行实际的下载操作。

--vlength

-v

否

下载完成后，验证本地文件大小是否与桶中对象的大小一致。

--vmd5

-M

否

下载完成后，验证本地文件的MD5值是否与桶中对象的MD5值一致。

桶中对象必须包含元数据x-obs-md5chksum，否则会忽略MD5值校验。

--threshold

-t

否

开启分段下载任务的阈值，单位：字节，默认为配置文件中的defaultBigfileThreshold。

如果待下载的对象小于该阈值，则使用直接下载模式；否则使用分段下载模式。直接下载模式不会产生断点记录文件，不支持断点续传。支持带容量单位配置，例如，配置1MB代表1048576字节。

--versionId

-V

否

下载单个对象时可指定的对象版本号。

--ps

-s

否

每个分段下载任务的段大小，单位：字节，默认为配置文件中的defaultPartSize。

支持带容量单位配置，例如，配置1MB代表1048576字节。支持配置为auto，此时obsutil会根据源对象大小自动设置每个分段任务的段大小。

--cpd

-C

否

生成断点记录文件的文件夹，默认为运行obsutil命令的用户目录的子文件夹.obsutil_checkpoint。

每个分段下载任务会产生唯一对应的断点记录文件并保存至该文件夹的down子文件夹下，分段任务执行成功后，对应的断点记录文件会被自动删除；分段任务执行失败或被中断后，下次执行该分段任务时会尝试通过对应的断点记录文件恢复任务。

--exclude

-x

否

不包含源对象的匹配模式，如：*.txt。

支持“*”匹配多个任意字符和“?”匹配单个任意字符，例如abc*.txt代表匹配以abc开头以.txt结尾的任意文件。

您可以使用“\*”代表匹配“*”字符本身，使用“\?”代表匹配“?”字符本身。如果待下载的对象名匹配该参数，则跳过该对象的复制。

建议使用引号传递该匹配模式（macOS/Linux操作系统使用单引号，Windows操作系统使用双引号）防止特殊符号被操作系统转义，导致不可预期的结果。该匹配模式作用于对象全路径（含从根路径开始的对象前缀和对象名，例如，桶内对象路径为obs://bucket/src1/src2/test.txt，则对象的全路径为src1/src2/test.txt）。该匹配模式仅适用于对象名非“/”结尾的对象。

支持指定多个exclude参数，如--exclude *.xxx --exclude *.xxx。

--include

-I

否

包含源对象的匹配模式，如：*.jpg。

支持“*”匹配多个任意字符和“?”匹配单个任意字符。

您可以使用“\*”代表匹配“*”字符本身，使用“\?”代表匹配“?”字符本身。首先执行exclude的匹配规则，如果待下载的对象名不匹配exclude，则判断待下载的对象名是否匹配该参数，如果匹配则下载该对象，否则跳过该文件的下载。

建议使用引号传递该匹配模式（macOS/Linux操作系统使用单引号，Windows操作系统使用双引号）防止特殊符号被操作系统转义，导致不可预期的结果。该匹配模式作用于对象全路径（含从根路径开始的对象前缀和对象名，例如，桶内对象路径为obs://bucket/src1/src2/test.txt，则对象的全路径为src1/src2/test.txt）。该匹配模式仅适用于对象名非“/”结尾的对象。

支持指定多个include参数，如--include *.xxx --include *.xxx。

--timeRange

-T

否

下载对象时的时间段匹配模式，仅下载最后修改时间在该时间段内的对象。该匹配模式优先级低于对象名匹配模式：exclude和include，优先执行对象名匹配模式后才会执行该匹配模式。

使用“time1-time2”，代表匹配的时间段，其中time1必须小于等于time2，格式为yyyyMMddHHmmss。时间格式支持自动补全，例如yyyyMMdd等价于yyyyMMdd000000，yyyyMM等价于yyyyMM01000000。

使用“*-time2”，代表匹配最后修改时间在time2之前的所有文件，使用“time1-*”，代表匹配最后修改时间time1之后的所有文件。

该匹配模式表示的时间是UTC时间。该匹配模式仅适用于对象名非“/”结尾的对象。

--mf

-m

否

设置名称匹配模式（include、exclude）和时间匹配模式（timeRange），对对象名以“/”结尾的对象也生效。

--o

-o

否

生成结果清单文件的文件夹，命令执行完成后，会在该文件夹下生成结果清单文件（可能包含成功结果、失败结果和警告结果三个文件），默认为运行obsutil命令的用户目录的子文件夹.obsutil_output。

结果清单文件命名规则：cp_{succeed | failed | warning}_report_时间_TaskId.txt。单个结果清单文件默认情况下最大为30MB且最大可保留的文件个数为1024，可在配置文件中通过recordMaxLogSize和recordBackups分别配置。

当涉及多文件/文件夹时，如需确认失败任务的具体错误信息，可参考结果清单文件夹下的失败结果清单文件“cp_failed_report_时间_TaskId.txt”及日志路径下的日志文件。

--e

-P

否

指定终端节点。

--i

-i

否

指定用户的AK。

--k

-k

否

指定用户的SK。

--t

-n

否

指定用户的securitytoken。

--recover

-z

否

待恢复下载任务结果清单文件的任务号。

任务号（TaskId）可在每次下载任务运行完毕后获取，或者通过结果清单文件名查询（文件名除去后缀.txt后的后36位）。

待恢复的下载任务会从结果清单的文件夹中查找，结果清单文件夹的路径参考附加参数--o。