ossutil allows you to use command lines to manage OSS data. ossutil provides a variety of simple commands for you to manage buckets and objects. The following operating systems support ossutil: Windows, Linux, and macOS.
ossutil allows you to perform the following operations:
- Manage buckets, such as create, list, and delete buckets.
- Manage objects, such as upload, download, list, copy, and delete objects.
- Manage parts, such as list and delete parts.
Install ossutil
For more information about how to download and install ossutil, see Download and installation.
Common commands
The following table describes common commands that are supported by ossutil.
| Command | Description |
|---|---|
| appendfromfile (append upload) | Uploads a local file to an append object in OSS by using append upload. |
| bucket-encryption (server-side encryption) | Adds, modifies, queries, or deletes encryption configurations for a bucket. |
| bucket-policy (manage bucket policies) | Adds, modifies, queries, or deletes bucket policy configurations for a bucket. |
| bucket-tagging (manage bucket tags) | Adds, modifies, queries, or deletes tagging configurations for a bucket. |
| bucket-versioning (configure or query bucket versioning status) | Adds or queries versioning configurations for a bucket. |
| cat | Exports object content to ossutil. |
| config | Generates a configuration file to store OSS access information. |
| cors | Adds, modifies, queries, or deletes cross-origin resource sharing (CORS) configurations for a bucket. |
| cors-options | Tests whether a bucket allows a specified cross-region request. |
| Overview | Uploads, downloads, or copies objects. |
| create-symlink (create a symbolic link) | Creates a symbolic link. |
| du (query object sizes) | Queries the storage usage of a specified bucket, object, or folder. |
| getallpartsize | Queries the size of each part in a bucket that has not been uploaded and the total size of all of those parts. |
| hash | Calculates the CRC-64 value or MD5 hash of a local file. |
| help | Queries help information about a command. We recommend that you use the help command to query information about a specified command. |
| inventory (configure bucket inventories) | Adds, queries, lists, or deletes inventory configurations for a bucket. |
| lifecycle (manage lifecycle rules) | Adds, modifies, queries, or deletes lifecycle configurations for a bucket. |
| listpart | Lists the parts that have not been uploaded for an object. |
| logging | Adds, modifies, queries, or deletes logging configurations for a bucket. |
| ls (list buckets, objects, or parts) | Lists buckets, objects, or parts. |
| mb (create buckets) | Creates a bucket. |
| mkdir (create directories) | Creates a folder in a bucket. |
| object-tagging (add, modify, query, and delete object tags) | Adds, modifies, queries, or deletes tagging configurations for an object. |
| probe | Monitors access to OSS. This command can also be used to troubleshoot issues that are caused by network faults or incorrect parameter settings during the upload and download process. |
| read-symlink (query a symbolic link) | Reads the description of a symbolic link object. |
| referer | Adds, modifies, queries, or deletes hotlink protection configurations for a bucket. |
| restore (restore objects) | Restores an object from the frozen state to the readable state. |
| request-payment (configure pay-by-requester) | Configures or queries pay-by-requester configurations for a bucket. |
| revert-versioning | Removes delete markers whose IS_LATEST are set to true. This way, the latest previous version becomes the current version. |
| rm (delete objects, parts, or buckets) | Deletes buckets, objects, or parts. |
| set-acl (configure or modify object or bucket ACLs) | Configures the ACL for a bucket or an object. |
| set-meta | Configures the metadata for an uploaded object. |
| sign | Generates signed URLs for third-party users to access objects in a bucket. |
| stat | Obtains the description of a specified bucket or object. |
| update | Updates the ossutil version. |
| website | Adds, modifies, queries, or deletes static website hosting and back-to-origin configurations for a bucket. |