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