Object Storage Service:set-props

Parameter

Type

Description

--acl

string

The ACL of the object. Valid values:

• private: private

• public-read: public-read

• public-read-write: public-read-write

• default: inherited from the bucket

--bigfile-threshold

int

The object size threshold for multipart upload, download, and copy. Default value: 104857600.

--cache-control

string

The caching behavior of the web page when the object is downloaded.

--content-disposition

string

The display form of the object.

--content-encoding

string

The encoding method used to encode the object.

--content-type

string

The content type of the object.

-d, --dirs

/

Specifies that the objects and subdirectories in the current directory are returned.

--encoding-type

string

The encoding method used to encode the object name. Valid value: url.

--end-with

string

Specifies that objects whose names are alphabetically before or the same as the value of the --end-with parameter are returned.

--exclude

stringArray

The exclusion rule for the path or object name.

--exclude-from

stringArray

Specifies that the exclusion rule is read from the rules file.

--expires

string

The absolute expiration time of the cached content.

--files-from

stringArray

Specifies that the source object names are read from the rules file, and empty lines or comment lines are ignored.

--files-from-raw

stringArray

Specifies that the source object names are read from the rules file.

--filter

stringArray

The filter rule for the path or object name.

--filter-from

stringArray

Specifies that the filter rule for the path or object name is read from the rules file.

-f, --force

/

Specifies that the command is forcibly run without a prompt for confirmation.

--include

stringArray

The inclusion rule for the path or object name.

--include-from

stringArray

Specifies that the inclusion rule is read from the rules file.

-j, --job

int

The number of concurrent tasks that can be performed on multiple objects. Default value: 3.

--list-objects

/

Specifies that the ListObjects operation is called to list objects.

--max-age

Duration

Specifies that the objects whose last modified time is earlier than the value of the --max-age parameter are not transferred. The default unit is seconds. The unit can be milliseconds, seconds, minutes, hours, days, weeks, months, or years. By default, this parameter is left empty.

--max-mtime

Time

Specifies that the objects whose last modified time is later than the value of the --max-mtime parameter are not transferred. The value is in UTC. By default, this parameter is left empty.

--max-size

SizeSuffix

The maximum size of the object that can be transferred. The default unit is bytes. The unit of object size can be bytes, KiB, MiB, GiB, TiB, or PiB. Note: 1 KiB = 1,024 bytes.

--metadata

strings

The user metadata of the object in the key=value format.

Example: --metadata test=value,test1=value1.

--metadata-directive

string

The parameter used to modify the object metadata. Valid values:

• replace: retains the metadata in the command line options.

• update: retains the intersection of metadata in the command line options and the object.

• purge: deletes all metadata.

• delete: deletes the metadata in the command line options and retains other metadata.

--metadata-exclude

stringArray

The exclusion rule for object metadata.

--metadata-filter

stringArray

The filter rule for object metadata.

--metadata-filter-from

stringArray

Specifies that the filter rule for object metadata is read from the rules file.

--metadata-include

stringArray

The inclusion rule for object metadata.

--min-age

Duration

Specifies that the objects whose last modified time is later than the value of the --min-age parameter are not transferred. The default unit is seconds. The unit can be milliseconds, seconds, minutes, hours, days, weeks, months, or years. By default, this parameter is left empty.

--min-mtime

Time

Specifies that the objects whose last modified time is earlier than the value of the --min-mtime parameter are not transferred. The value is in UTC. By default, this parameter is left empty.

--min-size

SizeSuffix

The minimum size of the object that can be transferred. The default unit is bytes. The unit of object size can be bytes, KiB, MiB, GiB, TiB, or PiB. Note: 1 KiB = 1,024 bytes.

--no-progress

/

Specifies that the progress bar is not displayed.

--page-size

int

The maximum number of objects that can be returned. Default value: 1000. Valid values: 1 to 1000.

--parallel

int

The number of concurrent tasks for internal operations on a single object.

--part-size

SizeSuffix

The part size. By default, ossutil calculates the appropriate part size based on the object size. Valid values: 100 KiB to 5 GiB.

-r, --recursive

/

Specifies that the command is recursively run on objects. If this parameter is specified, the set-props command takes effect on all objects that meet the conditions in the bucket. Otherwise, the set-props command takes effect only on the objects in the specified path.

--request-payer

string

The payer of the request. If pay-by-requester is enabled for the bucket, set this parameter to requester.

--start-after

string

Specifies that objects whose names are alphabetically after the value of the --start-after parameter are returned.

--storage-class

string

The storage class of the object. Valid values:

• Standard

• IA

• Archive

• ColdArchive

• DeepColdArchive

--tagging

strings

The tags of the object in the key=value format.

Example: --tagging tag1=value1,tag2=value2.

--tagging-directive

string

The parameter used to modify the object tags. Valid values:

• replace: retains the tags in the command line options.

• update: retains the intersection of tags in the command line options and the object.

• purge: deletes all tags.

• delete: deletes the tags in the command line options and retains other tags.

--version-id

string

The version ID of the object.

--list-format

string

The format of the list file. Valid values: plain and inventory.

--list-manifest-from

string

Read the format description of the list file from the file. You are required to specify this parameter if the format is inventory.