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