Object Storage Service:Download objects

Item

Description

cloud_url

The path of the object that you want to download from OSS. The path format is oss://bucketname/objectname. Example: oss://examplebucket/examplefile.txt.

file_url

The local path to which you want to download the object from OSS. An example file path on Linux is /localfolder/examplefile.txt. An example file path on Windows is D:\localfolder\examplefile.txt.

-r, --recursive

The recursive operations. If you configure this option, ossutil performs operations on all objects in a bucket that meet the specified condition. If you do not specify this option, ossutil performs operations only on the specified object.

-f --force

Forces an operation without requiring user confirmation.

-u, --update

Specifies that ossutil downloads an object from OSS only when the destination file does not exist in the local device or when the last modification time of the source object is later than that of the destination file.

--maxdownspeed

Specifies the maximum download speed. Unit: KB/s. The default value is 0, which indicates that the download speed is unlimited.

--disable-ignore-error

Specifies that errors are not ignored during batch operations.

--only-current-dir

Specifies that only objects in the current directory are downloaded. Subdirectories in the current directory and objects in these subdirectories are not downloaded.

--bigfile-threshold

Specifies the object size threshold for using resumable download. If an object exceeds the value of this option, the object is downloaded by using resumable download. Unit: bytes.

Default value: 104857600 (100 MB).

Valid values: 0 to 9223372036854775807.

--part-size

Specifies the part size. Unit: bytes. By default, ossutil determines the part size based on the object size.

Valid values: 1 to 9223372036854775807.

--checkpoint-dir

Specifies the directory in which the checkpoint information about resumable download is stored. If a resumable download task fails, ossutil automatically creates a directory named .ossutil_checkpoint and saves the checkpoint information in the directory. If the resumable download task is successful, ossutil deletes the directory. Therefore, if you specify a checkpoint directory, make sure that the directory can be deleted.

--range

Specifies that a specific range of the object content is downloaded and stored as a new file in the destination local path. The minimum start value of the range is 0, which indicates the byte 0 of the content of the object. You can specify a value for this option in one of the following formats:

• Specifies the data range that you want to download.

  For example, a value of 3-9 indicates a range from byte 3 to byte 9.

• Start value

  For example, a value of 3- indicates a range from byte 3 to the end of the object.

• End value

  For example, the value of -9 indicates a range from byte 0 to byte 9.

--encoding-type

Specifies the method that is used to encode the names of objects. Set the value to url. If you do not specify this option, the names of objects are not encoded.

--include

Specifies that the objects that meet the specified inclusion conditions are downloaded.

For more information, see Options --include and --exclude.

--exclude

Specifies that the objects that meet the specified exclusion conditions are not downloaded.

For more information, see Options --include and --exclude.

--meta

Specifies object metadata in the header:value#header:value format. Example: Cache-Control:no-cache#Content-Encoding:gzip. For more information about object metadata, see set-meta (manage object metadata).

--acl

The access control list (ACL) of the objects. Valid values:

• default: The ACL of the objects is the same as the ACL of the bucket in which the objects are stored.

• private: Only the bucket owner can perform read and write operations on objects in the bucket. Other users cannot access the objects in the bucket.

• public-read: Only the bucket owner can perform read and write operations on the objects in the bucket. Other users, including anonymous users, can perform only read operations on the objects in the bucket. This may result in unauthorized access to the data in your bucket and high fees. Proceed with caution when you set the object ACL to public-read.

• public read-write: All users, including anonymous users, can perform read and write operations on the objects in the bucket. This may result in unauthorized access to the data in your bucket and high fees. If a user uploads prohibited data or information, your legitimate interests and rights may be infringed. Therefore, we recommend that you do not set the object ACL to public-read-write except in special cases.

--snapshot-path

Specifies the directory in which the snapshots of downloaded objects are stored. In the next download task, ossutil reads the snapshots in this directory to download only incremental objects.

--disable-crc64

Specifies that CRC-64 is disabled. By default, ossutil enables CRC-64 during data transmission.

--payer

Specifies the payer of the request. If you want the requester who accesses the resources in the specified path to pay the traffic and request fees, set this option to requester.

--partition-download

Specifies the partition in which the object that you want to download is stored. The value of this option is in the Number of partition to download:Total number of partitions format. For example, the value 1:5 specifies that the object is split into five partitions and the current command downloads partition 1. Partitions are numbered starting from 1. Partitioning rules for objects are determined by ossutil. This option splits an object into multiple partitions that can be concurrently downloaded by multiple ossutil commands. Each ossutil command downloads its own partition.

-j, --job

Specifies the number of concurrent tasks performed across multiple objects. Valid values: 1 to 10000. Default value: 3.

--parallel

Specifies the number of concurrent tasks to download a single object. Valid values: 1 to 10000. If you do not configure this option, ossutil specifies a value based on the operation type and the object size.

--version-id

Specifies the version ID of the object that you want to download. You can use this option for objects only in a bucket for which versioning is enabled.

--start-time

Specifies the start of the time range to filter objects by last modified time. The value is a UNIX timestamp. Objects whose last modified time is earlier than the UNIX timestamp are ignored.

--end-time

Specifies the end of the time range to filter objects by last modified time. The value is a UNIX timestamp. Objects whose last modified time is later than the timestamp are ignored.