View options

Option Name

Description

-s, --short-format

Displays results in short format. Default: long format.

--bigfile-threshold

The file size threshold for resumable upload. Unit: bytes. Default: 100 MB. Range: 0 to 9223372036854775807.

--acl

Configures the access control list (ACL).

--range

Specifies a zero-based byte range to download from a file.

• You can specify a range. For example, 3-9 indicates the 3rd to the 9th byte, inclusive.

• You can specify a starting point, such as 3-, to download from byte 3 to the end of the file, inclusive.

• You can specify the end position. For example, -9 specifies the range from byte 0 to byte 9.

--all-versions

Specifies all versions of an object.

--type

The data validation method. Valid values:

• crc64 (default): Performs a 64-bit cyclic redundancy check (CRC64).

• md5: Performs MD5 validation.

-v, --version

Displays the version of ossutil and exits.

-u, --update

Performs an update operation.

--origin

The value of the origin field in the HTTP request header.

--upmode

The upload mode used in the probe command. Valid values:

• normal (default): Simple upload.

• append: Append upload.

• multipart: Multipart upload.

--sse-algorithm

The server-side encryption algorithm for the bucket. Valid values:

• KMS: Uses a Key Management Service (KMS) managed key for encryption and decryption, which is SSE-KMS.

• AES256: Uses an OSS managed key for encryption and decryption, which is SSE-OSS.

--include

Lists objects that meet the specified conditions. For example, *.jpg lists all files in the JPG format.

The --include and --exclude options.

--exclude

Lists objects that do not meet the specified conditions. For example, *.txt lists all files that are not in the TXT format.

The --include and --exclude options.

-r, --recursive

Recursively operates on all matching objects in the bucket. Without this option, only the specified object is affected.

--addr

Specifies a network address for connectivity testing via ping.

Default value: www.aliyun.com

--kms-masterkey-id

The ID of the customer master key (CMK) in KMS.

--version-id

The version ID of the object.

--version-id-marker

Lists object versions with IDs alphabetically after the specified marker. Requires versioning to be enabled.

-m, --multipart

Specifies that the operation applies to incomplete multipart upload events in the bucket.

-d, --directory

Returns only the files and subdirectories in the current directory.

--payer

The request payer. Set to requester for pay-by-requester mode.

--maxupspeed

The maximum upload speed. Unit: KB/s. Default: 0 (no limit).

--maxdownspeed

The maximum download speed. Unit: KB/s. Default: 0 (no limit).

--retry-times

The number of retries after an error. Default: 10. Range: 1 to 500.

--download

Probes network connectivity by downloading an object from the destination bucket using the file URL.

-j, --jobs

The number of concurrent tasks for multi-file operations. Default: 3. Range: 1 to 10000.

-a, --all-type

Specifies that the operation applies to objects and incomplete multipart upload events in the bucket.

--disable-empty-referer

Specifies that the Referer field cannot be empty.

--method

The HTTP request method. Valid values include PUT, GET, and DELETE.

--output-dir

The output directory for report files, such as batch copy failure reports from the cp command.

Default: the ossutil_output directory in the current directory.

--meta

Sets object metadata. Format: Cache-Control:no-cache#Content-Encoding:gzip.

--object

Specifies the file name in the probe command.

--end-time

A UNIX timestamp. If you use this option, objects last modified later than the specified time are ignored.

--limited-num

The maximum number of results to return.

-L, --language

Sets the language for ossutil. Valid values:

• CH (default): Chinese. If you set the language to CH, make sure your system encoding is UTF-8.

• EN: English.

--delete

Deletes a bucket, object, or fragment.

-b, --bucket

Use this option only when you delete a bucket.

--disable-crc64

Disables CRC64 validation. By default, ossutil enables CRC64 validation for data transfer.

--upload

Probes network connectivity by uploading a local file to the destination bucket.

--part-size

The part size. Unit: bytes. By default, ossutil calculates the part size based on file size. Range: 1 to 9223372036854775807.

--timeout

The signed URL timeout. Unit: seconds. Default: 60. Range: 0 to 9223372036854775807.

--checkpoint-dir

The directory for resumable upload/download checkpoint data. On failure, ossutil creates a .ossutil_checkpoint directory that is deleted after the operation succeeds. Ensure the specified directory is deletable.

--url

The file URL.

--marker

Lists buckets, objects, or parts whose names are alphabetically after the specified marker.

-f, --force

Forces the operation without a confirmation prompt.

--snapshot-path

The directory for snapshot data used in incremental uploads and downloads.

• --snapshot-path accelerates incremental transfers of large file sets when no other user has modified the corresponding OSS objects between operations. Not supported for copy operations.

• --snapshot-path records the `lastModifiedTime` of successfully transferred files and skips unchanged files in subsequent runs. If other users may modify OSS objects, use --update instead.

• Snapshot data is not deleted automatically. Clear the snapshot path when no longer needed.

• This option adds I/O overhead. For small file sets or shared objects, use --update instead.

• --update and --snapshot-path can be combined. ossutil checks the snapshot first, then falls back to --update.

--start-time

A UNIX timestamp. If you use this option, objects last modified earlier than the specified time are ignored.

--storage-class

The storage class. Valid values:

• Standard (default): For frequently accessed data.

• IA: Infrequent Access. For data accessed once or twice a month. Minimum storage: 30 days. Minimum billable size: 64 KB. Real-time access with data retrieval fees.

• Archive: Long-term data archival. Minimum storage: 60 days. Minimum billable size: 64 KB. Requires restoration (~1 minute) before access. Data retrieval fees apply.

• ColdArchive: Extremely cold data requiring long-term storage. Minimum storage: 180 days. Minimum billable size: 64 KB. Requires restoration before access; time varies by data size and restoration mode. Data retrieval fees apply.

-t, --sts-token

The STS token for temporary credential access. Required only with STS credentials and overrides the configuration file setting. Temporary access credentials.

--parallel

The number of concurrent tasks for single-file operations. Range: 1 to 10000. Default: determined by operation type and file size.

--partition-download

Specifies a partition for parallel downloads. Format: partition_number:total_partitions. For example, 1:5 downloads partition 1 of 5. Partition numbers are 1-based. Multiple ossutil instances can download different partitions in parallel.

--bucketname

The bucket name.

--encoding-type

URL-encodes the object key after oss://bucket_name. Valid value: url. If omitted, the key is not encoded.

--origin

The Origin HTTP request header value, used to identify cross-origin requests.

--acr-method

The value of the Access-Control-Request-Method HTTP request header. Valid values are GET, PUT, POST, DELETE, and HEAD.

--acr-headers

The Access-Control-Request-Headers value for CORS preflight requests. Separate multiple headers with commas and enclose in double quotes, for example, --acr-headers "header1,header2,header3".

--upload-id-marker

Lists parts whose upload IDs are alphabetically after the specified marker.

-h, --help

Displays help information.

--trafic-limit

The HTTP speed limit for the sign command. Unit: bit/s.

Default: 0 (no limit).

Range: 819200 to 838860800 (100 KB/s to 100 MB/s).

--local-host

The local IP address for OSS access in the cp command.

--enable-symlink-dir

Uploads linked subdirectories (skipped by default). Use the probe command to detect circular symlinks.

--only-current-dir

Processes only files in the current directory, ignoring subdirectories.

--disable-dir-object

Skips creating directory objects during upload. The directory structure remains visible in the console but disappears when all files within it are deleted.

--probe-item

The probe target. Valid values:

• upload-speed: Probes the upload bandwidth.

• download-speed: Probes the download bandwidth.

• cycle-symlink: Probes whether there are infinite loop link files or directories in the local file directory.

--redundancy-type

The data redundancy type of the bucket. Valid values:

• LRS (default): Locally redundant storage (LRS) stores your data redundantly on different storage devices in the same zone. It ensures data durability and availability even if two storage devices are concurrently damaged.

• ZRS: Zone-redundant storage (ZRS) uses a multi-zone data redundancy mechanism to store your data redundantly across multiple zones in the same region. It ensures data availability even if a zone becomes unavailable.

--disable-encode-slash

Does not encode the forward slash (/) in the URL.

--disable-all-symlink

Ignores all symbolic link subfiles and symbolic link subdirectories during upload.

--tagging

Sets object tags during upload or copy. Format: "abc=1&bcd=2&...".

--disable-ignore-error

Terminates immediately on error instead of continuing batch operations.

--block-size

The unit for object sizes in output. Valid values: KB, MB, GB, or TB. Default: bytes.