1OSSUTIL(1) User Commands OSSUTIL(1)
2
6 ossutil - Alibaba Cloud (Aliyun) Object Storage Service (OSS) CLI
7
9 Usage of ossutil:
10
12 --method=
13 specifies the command's operation type. the values â.â.are
14 PUT, GET, DELETE, LIST, etc
15 --proxy-user=
17 username of network proxy, default is empty
18 -a, --all-type
20 Indicate that the subject of the command contains both objects
21 and uncompleted Multipart Uploads.
22 --end-time=
24 The end time is the timestamp in the Linux/Unix system, that is,
25 the number of seconds that have passed since January 1, 1970
26 (midnight UTC/GMT)
27 --addr=
29 specifies a network address,usually a domain,primarily used in
30 probe command
31 --disable-empty-referer
33 specifies that the referer field is not allowed to be empty,pri‐
34 marily used in referer command
35 --probe-item=
37 specifies probe command's probe item, the value can be up‐
38 load-speed, download-speed, cycle-symlink
39 --storage-class=
41 set the storage class of bucket(default: Standard), value range
42 is: Standard/IA/Archive/ColdArchive.
43 --checkpoint-dir=
45 Path of checkpoint directory(default:.ossutil_checkpoint), the
46 directory is used in resume upload or download, when operate
47 failed, ossutil will create the directory automatically, and
48 record the checkpoint information in the directory, when the op‐
49 eration is succeed, the directory will be removed, so when spec‐
50 ify the option, please make sure the directory can be removed.
51 --include=
53 Include Pattern of key, e.g., *.jpg
54 --meta=
56 Set object meta as [header:value#header:value...], e.g.,
57 Cache-Control:no-cache#Content-Encoding:gzip
58 --marker=
60 the marker of bucket when list buckets, or the marker of key
61 when list object or Multipart Uploads, Or other places where a
62 marker is needed
63 -b, --bucket
65 the option used to make sure the operation will operate on
66 bucket
67 --disable-crc64
69 Disable crc64, in default situation, ossutil open crc64 check
70 when transmit data.
71 --limited-num=
73 the limited number of return results.
74 --timeout=
76 time out of signurl, the unit is: s, default value is 60, the
77 value range is: 0-9223372036854775807
78 -L, --language=
80 set the language of ossutil(default: EN), value range is: CH/EN,
81 if you set it to "CH", please make sure your system language is
82 UTF-8.
83 --delete
85 delete
86 --disable-encode-slash
88 specifies no encoding of '/' in url path section, primarily used
89 in sign command
90 --type=
92 hash type, Default: crc64, value range is: crc64/md5
93 --acr-method=
95 specifies the value of the http header Access-Control-Re‐
96 quest-Method,primarily used in cors-options command.
97 -t, --sts-token=
99 STSToken while access oss(Notice that the value of the option
100 will cover the value in config file), not necessary.
101 --acl= acl information.
103 -m, --multipart
105 Indicate that the subject of the command are uncompleted Multi‐
106 part Uploads, instead of objects(which is the subject in default
107 situation.
108 --payer=
110 The payer of the request. You can set this value to "requester"
111 if you want pay for requester
112 --loglevel=
114 log level,default is empty(no log file output),optional value
115 is:info|debug,info will output information logs,debug will out‐
116 put detail logs(including http request and response logs)
117 --download
119 specifies download action from oss,primarily used in probe com‐
120 mand
121 --kms-masterkey-id=
123 specifies the primary key id in the kms(key management service)
124 --disable-all-symlink
126 specifies that uploading of symlink files and symlink directo‐
127 ries under the directory is not allowed, the default value is
128 false.
129 --retry-times=
131 retry times when fail(default: 10), value range is: 1-500
132 --snapshot-path=
134 This option is used to accelerate the incremental upload of
135 batch files or download objects in certain scenarios. If you use
136 the option when upload files or download objects, ossutil will
137 generate files to record the snapshot information in the speci‐
138 fied directory. When the next time you upload files or download
139 objects with the option, ossutil will read the snapshot informa‐
140 tion under the specified directory for incremental upload or in‐
141 cremental download. The snapshot-path you specified must be a
142 local file system directory can be written in, if the directory
143 does not exist, ossutil creates the files for recording snapshot
144 information, else ossutil will read snapshot information from
145 the path for incremental upload(ossutil will only upload the
146 files which haven't not been successfully uploaded to oss or
147 been locally modified) or incremental download(ossutil will only
148 download the objects which have not been successfully downloaded
149 or have been modified), and update the snapshot information to
150 the directory. Note: The option record the lastModifiedTime of
151 local files which have been successfully uploaded in local file
152 system or lastModifiedTime of objects which have been success‐
153 fully downloaded, and compare the lastModifiedTime of local
154 files or objects in the next cp to decided whether to skip the
155 file or object. If you use the option to achieve incremental up‐
156 load, please make sure no other user modified the corresponding
157 object in oss during the two uploads. If you can not guarantee
158 the scenarios, please use --update option to achieve incremental
159 upload. In addition, ossutil does not automatically delete snap‐
160 shot-path snapshot information, in order to avoid too much snap‐
161 shot information, when the snapshot information is useless,
162 please clean up your own snapshot-path on your own immediately.
163 --range=
165 the range when download objects, the form is like: 3-9 or 3- or
166 -9
167 --all-versions
169 specifies the object's all versions
170 --disable-ignore-error
172 specifies that do not ignore errors during batch cp, default
173 value is false
174 --object=
176 specifies a name of object,primarily used in probe command
177 --enable-symlink-dir
179 specifies uploading link subdirectories,default are not up‐
180 loaded; The probe command can detect whether there is a dead cy‐
181 cle symlink file or directory.
182 --part-size=
184 Part size, the unit is: Byte, in default situation, ossutil will
185 calculate the suitable part size according to file size. The op‐
186 tion is useful when user has special needs or user need to per‐
187 formance tuning, the value range is: 1-9223372036854775807(Byte)
188 -v, --version
190 Show ossutil version (v1.7.3) and exit.
191 -f, --force
193 operate silently without asking user to confirm the operation.
194 --upload
196 specifies upload action to oss,primarily used in probe command
197 --trafic-limit=
199 http request speed limit,the unit is:bit/s,default value is
200 0(unlimited),primarily used in sign command
201 --redundancy-type=
203 specifies bucket data redundancy type, the value can be LRS,
204 ZRS. LRS is default value, specifies locally redundant storage;
205 ZRS specifies higher availability of redundant storage
206 -p, --password
208 specifies that the accessKeySecret is inputted from the keyboard
209 -u, --update
211 update
212 --url= specifies a url address,primarily used in probe command
214 --version-id=
216 specifies the object's version id
217 --only-current-dir
219 specifies that only files or objects in the current directory
220 are manipulated, and subdirectories are ignored.
221 --start-time=
223 The start time is the timestamp in the Linux/Unix system, that
224 is, the number of seconds that have passed since January 1, 1970
225 (midnight UTC/GMT)
226 --parallel=
228 amount of concurrency tasks when work with a file, value range
229 is: 1-10000, by default the value will be decided by ossutil in‐
230 telligently.
231 --encoding-type=
233 the encoding type of object name or file name that user inputs
234 or outputs, currently ossutil only supports url encode, which
235 means the value range of the option is: url, if you do not spec‐
236 ify the option, it means the object name or file name that user
237 inputed or outputed was not encoded. bucket name does not sup‐
238 port url encode. Note, if the option is specified, the cloud_url
239 like: oss://bucket/object should be inputted as:
240 oss://bucket/url_encode(object), the string: oss://bucket/
241 should not be url encoded.
242 -d, --directory
244 Return matching subdirectory names instead of contents of the
245 subdirectory.
246 -r, --recursive
248 operate recursively, for those commands which support the op‐
249 tion, when use them, if the option is specified, the command
250 will operate on all match objects under the bucket, else we will
251 search the specified object and operate on the single object.
252 --upmode=
254 specifies the upload mode,default value is normal,optional value
255 is:normal|append|multipart, which means normal uploadã.'append
256 upload and multipart upload,it is primarily used in probe com‐
257 mand.
258 --partition-download=
260 the option is used in partition download mode, one command to
261 download one partition,the value format is "partition number:to‐
262 tal count of partitions",such as 1:5, indicating that the com‐
263 mand downloads partition 1,total partition count is 5; the par‐
264 tition number is numbered from 1, and the partitioning rules for
265 objects are determined by ossutil; with this option, the objects
266 to be downloaded are divided into multiple partitions, which can
267 be downloaded by multiple ossutil commands,each ossutil command
268 can download its own partition,multiple ossutil commands can be
269 executed on different machines in parallel.
270 -B, --block-size=
272 specifies the unit of byte display for du command, the value can
273 be KB, MB, GB, TB
274 -j, --jobs=
276 amount of concurrency tasks between multi-files(default: 3),
277 value range is: 1-10000
278 -c, --config-file=
280 Path of ossutil configuration file, where to dump config in con‐
281 fig command, or to load config in other commands that need cre‐
282 dentials.
283 -s, --short-format
285 Show by short format, if the option is not specified, show long
286 format by default.
287 --maxupspeed=
289 max upload speed,the unit is:KB/s,default value is 0(unlimited)
290 --upload-id-marker=
292 the marker of object when list object or Multipart Uploads.
293 --origin=
295 specifies the value of origin field in http header
296 --sse-algorithm=
298 specifies the server side encryption algorithm,value is KMS or
299 AES256.
300 --kms-data-encryption=
302 specifies the kms data service encryption algorithm,Currently
303 only supports the value SM4 or emtpy
304 --proxy-pwd=
306 password of network proxy, default is empty
307 --output-dir=
309 The option specify the directory to place output file in, output
310 file contains: report file generated by cp command when error
311 happens of batch copy operation(for more information about re‐
312 port file, see help of cp command). The default value of the op‐
313 tion is: ossutil_output directory in current directory.
314 -i, --access-key-id=
316 AccessKeyID while access oss(Notice that the value of the option
317 will cover the value in config file).
318 --bucketname=
320 specifies a name of bucket,primarily used in probe command
321 --version-id-marker=
323 specifies the marker of object version id when list objects's
324 all versions
325 --proxy-host=
327 url of network proxy server, which supports http/https/socks5,
328 such as https://120.79.128.211:3128,
329 socks5://120.79.128.211:1080
330 --local-host=
332 ossutil's ip ,such as 127.0.0.1
333 -e, --endpoint=
335 Base endpoint for oss endpoint(Notice that the value of the op‐
336 tion will cover the value in config file). Take notice that it
337 should be second-level domain(SLD).
338 -k, --access-key-secret=
340 AccessKeySecret while access oss(Notice that the value of the
341 option will cover the value in config file).
342 --acr-headers=
344 specifies the value of the http header Access-Control-Re‐
345 quest-Headers, primarily used in cors-options command.
346 --tagging=
348 Set object tagging, value format is ["TagA=A&TagB=B...]"
349 --bigfile-threshold=
351 the threshold of file size, the file size larger than the
352 threshold will use resume upload or download(default:
353 104857600), value range is: 0-9223372036854775807
354 --exclude=
356 Exclude Pattern of key, e.g., *.txt
357 --disable-dir-object
359 specifies that oss object is not generated for directory itself
360 when uploading, primarily used in cp command
361 --backup-dir=
363 The directory of the backup file used by the sync command
364 -h, --help
366 Show usage message
367 --version
369 Show version
370ossutil 1.7.3 April 2021 OSSUTIL(1)