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