ossutil allows you to manage Object Storage Service (OSS) data by using command lines on Windows, Linux, and macOS operating systems.
Upgraded features
We recommend you use ossutil2.0. For information about how to quickly install and use ossutil, see Install ossutil.
Key features of ossutil 2.0:
New command syntax: Multi-level commands are introduced, including API-level commands, such as
ossutil api put-bucket-acl, and high-level commands, such asossutil config.Optimized configuration mechanism: The initial configuration process is simplified. You need only to specify the AccessKey ID, AccessKey secret, and region ID to complete the basic configurations after you install ossutil. You can also specify multiple configuration files by using the
--profileparameter, which enhances flexibility.Multiple filter parameters: Various filter conditions based on path, file size, last modified time, and object metadata are provided for batch processing commands, such as
ls,cp, andrm, which greatly improves the accuracy and efficiency of operations.Flexible output formats: You can use the
--output-formatparameter to set the output format of output files to JSON, YAML, or XML to better meet different data processing requirements. You can also specify the--output-queryoption to filter output files to obtain the required information.Enhanced security: To improve data security, ossutil 2.0 allows users to specify sensitive parameters by using environment variables, which avoids exposing keys in the command line and reduces leakage risks. In addition, the
--dry-runoption allows users to verify their behavior before the commands are executed, which ensures that the operations are correct.
Install ossutil
For more information about how to download and install ossutil, see Install ossutil.
Configure ossutil
For more information about how to configure ossutil, see Configure ossutil.
Common commands
The following table describes common commands that are supported by ossutil.
Command | Description |
Specifies the access tracking state of a bucket. | |
Appends content to existing appendable objects. | |
Queries the CNAME configurations of a bucket. | |
Adds encryption configurations to a bucket, or modifies, queries, and deletes the encryption configurations of a bucket. | |
Adds bucket policy configurations to a bucket, or modifies, queries, and deletes the bucket policy configurations of a bucket. | |
Adds tagging configurations to a bucket, or modifies, queries, and deletes the tagging configurations of a bucket. | |
Adds versioning configurations to a bucket, or queries the versioning configurations of a bucket. | |
Exports object content to ossutil. | |
Creates a configuration file to store information that is required to access OSS. | |
Adds cross-origin resource sharing (CORS) configurations to a bucket, or modifies, queries, deletes the cross-origin resource sharing (CORS) configurations of a bucket. | |
Tests whether a bucket allows a specified cross-origin request. | |
Uploads, downloads, or copies objects. | |
Creates a symbolic link. | |
Queries the storage usage of a specified bucket, object, or directory. | |
Queries the size of each part of incomplete multipart upload tasks in a bucket and the total size of these parts. | |
Calculates the CRC-64 or MD5 hash of a local file. | |
Queries help information about a command. We recommend that you run the help command to query information about how to run a specified command. | |
Adds inventory configurations to a bucket, or queries, lists, deletes the inventory configurations of a bucket. | |
Adds lifecycle configurations to a bucket, or modifies, queries, deletes the lifecycle configurations of a bucket. | |
Lists the parts generated in an incomplete multipart upload task initiated for an object. | |
Adds logging configurations to a bucket, or modifies, queries, deletes the logging configurations of a bucket. | |
Lists the buckets that are located in a region or multiple regions. | |
Lists buckets, objects, or parts. | |
Creates a bucket. | |
Creates a directory in a bucket. | |
Adds tagging configurations to a bucket, or modifies, queries, deletes the tagging configurations of an object. | |
Monitors access to OSS. You can also run this command to troubleshoot issues that are caused by network faults or invalid parameter settings during the upload and download process. | |
Reads the description of a symbolic link. | |
Adds hotlink protection configurations to a bucket, or modifies, queries, deletes the hotlink protection configurations of a bucket. | |
Manages the Cross-Region Replication (CRR) configurations of a bucket. | |
Configures the pay-by-requester mode for a bucket or queries the pay-by-requester configurations of a bucket. | |
Configures a resource group for a bucket and queries information about the resource group. | |
Restores an object from the frozen state to the readable state. | |
Recovers a deleted object to the most recent version of the object. | |
Deletes buckets, objects, or parts. | |
Configures the access control list (ACL) for a bucket or an object. | |
Configures the metadata of an uploaded object. | |
Generates a signed URL for an object and shares the signed URL with third parties for downloads or previews. | |
Obtains the description of a specified bucket or object. | |
Configures image styles. | |
Synchronizes local files to OSS, OSS objects to local disks, or objects between OSS paths. | |
Updates the ossutil version. | |
Adds static website hosting, redirection, or back-to-origin configurations to a bucket, or modifies, queries, deletes the static website hosting, redirection, or back-to-origin configurations of a bucket. | |
Queries the retention policies configured for a bucket. |
View options
For more information about the command-line options, see View options.
FAQ
For more information, see FAQ.