cp（下载文件）

API

Action

说明

GetObject

oss:GetObject

下载Object。

oss:GetObjectVersion

下载Object时，如果通过versionId指定了Object的版本，需要授予此操作的权限。

kms:Decrypt

下载Object时，如果Object的元数据包含X-Oss-Server-Side-Encryption: KMS，需要此操作的权限。

ListObjects

oss:ListObjects

批量下载文件（递归操作）时，需要授予此操作的权限。

参数

说明

cloud_url

OSS文件路径，格式为oss://bucket[/prefix]。如oss://examplebucket/examplefile.txt。

file_url

本地文件路径。如果目标是目录，需以路径分隔符（/ 或 \）结尾。如Linux系统文件路径/localfolder/examplefile.txt，Windows系统文件路径D:\localfolder\examplefile.txt。

-r, --recursive

递归操作。当指定该选项时，ossutil会对Bucket下所有符合条件的Object进行操作，否则只对指定的单个Object进行操作。

-f --force

强制操作，不进行询问提示。

-u，--update

只有当目标文件不存在，或源文件的最后修改时间晚于目标文件时，ossutil才会执行下载操作。

--maxdownspeed

最大下载速度，单位为KB/s。默认值为0，表示不限制下载速度。

--disable-ignore-error

批量操作时不忽略错误。

--only-current-dir

仅下载当前目录下的文件，忽略子目录及子目录下的文件。

--bigfile-threshold

设置断点续传文件的大小阈值，单位为字节。

默认值：100 MB

取值范围：0~9223372036854775807

--part-size

设置分片大小，单位为字节。默认情况下ossutil会根据文件大小自行计算合适的分片大小值。

取值范围：1~9223372036854775807

--checkpoint-dir

指定断点续传记录信息所在的目录。断点续传操作失败时，ossutil会自动创建名为.ossutil_checkpoint的目录，并在该目录下记录checkpoint信息，断点续传成功后会删除该目录。如果指定了该选项，请确保指定的目录可以被删除。

--range

下载目标文件的指定字段，并保存为一个新的文件，字段从0开始编号。

• 指定区间

  例如指定为3-9，表示下载文件的第3个字节到第9个字节（包含第3和第9字节）。

• 指定开始位置

  例如指定为3-，表示从第3个字节开始到文件结尾（包含第3个字节）。

• 指定结束位置

  例如指定为-9，表示从0字节到第9个字节（包含第9个字节）。

--encoding-type

文件名称的编码方式。取值为url。如果不指定该选项，则表示文件名称未经过编码。

--include

包含符合指定条件的所有文件。

更多信息，请参见include和exclude选项。

--exclude

不包含符合指定条件的文件。

更多信息，请参见include和exclude选项。

--meta

设置文件的元数据，格式为header:value#header:value，示例为Cache-Control:no-cache#Content-Encoding:gzip。有关元数据的介绍，请参见set-meta（管理文件元数据）。

--acl

文件的读写权限ACL。取值如下：

• default（默认值）：继承Bucket的读写权限。

• private：只有该Bucket的拥有者可以对该Bucket内的文件进行读写操作，其他人无法访问该Bucket内的文件。

• public-read：只有Bucket拥有者可以对该Bucket内的文件进行写操作，其他用户（包括匿名访问者）可以对该Bucket中的文件进行读操作。这有可能造成数据的外泄以及费用激增，请谨慎操作。

• public-read-write：任何人（包括匿名访问者）都可以对该Bucket内文件进行读写操作。这有可能造成数据的外泄以及费用激增，如果被人恶意写入违法信息还可能会侵害合法权益。除特殊场景外，不建议配置公共读写权限。

--snapshot-path

指定保存下载文件时的快照信息所在的目录。在下一次下载文件时，ossutil会读取指定目录下的快照信息进行增量下载。

--disable-crc64

关闭CRC64数据校验。默认情况下，ossutil进行数据传输时都会打开CRC64校验。

--payer

请求的支付方式。如果希望访问指定路径下的资源产生的流量、请求次数等费用由请求者支付，请将此选项的值设置为requester。

--partition-download

用于分区下载。该选项取值格式为分区编号：总分区数。例如1：5，表示当前ossutil下载分区1，总共有5个分区。分区号从1开始编号，Object的分区规则由工具内部算法决定。通过该选项将待下载的Object分成多个分区，并由多个ossutil命令并行下载，各个ossutil命令下载各自的分区。

-j，--job

多文件操作时的并发任务数，默认值为3，取值范围为1~10000。

--parallel

单文件操作时的并发任务数，取值范围为1~10000。 如果不设置此选项，默认由ossutil根据操作类型和文件大小自行决定。

--version-id

下载指定版本的文件，--version-id选项仅支持在已开启版本控制的Bucket内使用。开启Bucket版本控制命令请参见bucket-versioning（版本控制）。

--start-time

Unix时间戳。如果输入这个选项，最后更新时间早于该时间的Object会被忽略。

--end-time

Unix时间戳。如果使用该选项，则最后更新时间晚于通过此选项指定时间的Object会被忽略。