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