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