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