OSS工具 ossutil中文帮助文档
此工具一般安装在linux /root目录下
./ossutil64 help ls -L ch #查看中文帮助文档
------------------------------------------------------------------以下是文档正文部分-------------------------------------
SYNOPSIS
列举Buckets或者Objects
SYNTAX
ossutil ls [oss://bucket[/prefix]] [-s] [-d] [-m] [--limited-num num] [--marker marker] [--upload-id-marker umarker] [--payer requester] [--include include-pattern] [--exclude exclude-pattern] [--version-id-marker id_marker] [--all-versions] [-c file]
DETAIL DESCRIPTION
该命令列举指定身份凭证下的buckets,或该身份凭证下对应endpoint的objects。默认显示长格式,
ossutil在列举buckets或者objects的同时展示它们的一些附加信息。如果指定了--short-format选
项,则显示精简格式。
--encoding-type选项
如果指定了encoding-type为url,则表示输入的object(或prefix)为经过url编码的,此时如果指定了
--marker选项或--upload-id-marker选项,ossutil默认指定的marker或upload-id-marker也同样是经过
url编码的。注意:形如oss://bucket/object的cloud_url,输入形式为:oss://bucket/url_encode(object),
其中oss://bucket/字符串不需要编码。
--include和--exclude选项
可以指定该选项以指定规则筛选要操作的文件/object
规则支持以下格式:
*:匹配索引
?:匹配单个字符
[sequence]:匹配sequence的任意字符
[!sequence]:匹配不在sequence的任意字符
注意:规则不支持带目录的格式,e.g.,--include "/usr/*/test/*.jpg"。
--include和--exclude可以出现多次。当多个规则出现时,这些规则按从左往右的顺序应用
用法:
该命令有两种用法:
1) ossutil ls [oss://] [-s] [--limited-num num] [--marker marker]
如果用户列举时缺失cloud_url参数,则ossutil获取用户的身份凭证信息(从配置文件中读取),
并列举该身份凭证下的所有buckets,并显示每个bucket的最新更新时间,位置,存储方式等信息。
如果指定了--short-format选项则只输出bucket名称。该用法不支持--directory选项。
2) ossutil ls oss://bucket[/prefix] [-s] [-d] [-m] [-a] [--limited-num num] [--marker marker] [--upload-id-marker umarker] [--version-id-marker id_marker] [--all-versions]
如果未指定--multipart和--all-type选项,则ossutil列举指定bucket下的objects(如果指定
了前缀,则列举拥有该前缀的objects)。并同时展示object大小,最新更新时间和etag,但是如果
指定了--short-format选项则只输出object名称。如果指定了--directory选项,则返回指定bucket
下以指定前缀开头的第一层目录下的文件和子目录,但是不递归显示所有子目录,此时默认为精简
格式。所有的目录均以/结尾。
如果指定了--multipart选项,则显示指定URL(oss://bucket[/prefix])下未完成的上传任务,
即,列举未complete的Multipart Upload事件的uploadId,这些Multipart Upload事件的object名
称以指定的prefix为前缀。ossutil同时显示uploadId的init时间。该选项同样支持--short-format
和--directory选项。(Multipart同样用于cp命令中大文件的断点续传,关于Multipart的更多信息
见:https://help.aliyun.com/document_detail/31991.html?spm=5176.doc31992.6.880.VOSDk5)。
如果指定了--all-type选项,则显示指定URL(oss://bucket[/prefix])下的object和未完成的
上传任务(即,同时列举以prefix为前缀的object,和object名称以prefix为前缀的所有未complete
的uploadId)。该选项同样支持--short-format和--directory选项。
如果指定了--limited-num选项,ossutil总共会输出的对象个数不超过limited-num个,当同时
输出object和Multipart Upload时,两者的总数不超过limited-num个。
在列举objects时,--upload-id-marker选项不起作用。在列举Multipart Uploads事件时,--marker
和--upload-id-marker选项同时限定了列举的起始位置,更多信息请见oss的官网:
https://help.aliyun.com/document_detail/31997.html?spm=5176.doc31965.6.887.MK6GVw.
SAMPLE
1) ossutil ls -s
oss://bucket1
oss://bucket2
oss://bucket3
Bucket Number is: 3
2) ossutil ls oss:// -s
oss://bucket1
oss://bucket2
oss://bucket3
Bucket Number is: 3
3) ossutil ls oss://bucket1 -s
oss://bucket1/dir1/obj11
oss://bucket1/obj1
oss://bucket1/sample.txt
Object Number is: 3
4) ossutil ls oss://bucket1
LastModifiedTime Size(B) StorageClass ETAG ObjectName
2015-06-05 14:06:29 +0000 CST 201933 Standard 7E2F4A7F1AC9D2F0996E8332D5EA5B41 oss://bucket1/dir1/obj11
2015-06-05 14:36:21 +0000 CST 201933 Standard 6185CA2E8EB8510A61B3A845EAFE4174 oss://bucket1/obj1
2016-04-08 14:50:47 +0000 CST 6476984 Standard 4F16FDAE7AC404CEC8B727FCC67779D6 oss://bucket1/sample.txt
Object Number is: 3
5) ossutil ls oss://bucket1 -d
oss://bucket1/obj1
oss://bucket1/dir1
oss://bucket1/sample.txt
Object and Directory Number is: 3
6) ossutil ls oss://bucket1 -m
InitiatedTime UploadID ObjectName
2017-01-13 03:45:26 +0000 CST 15754AF7980C4DFB8193F190837520BB oss://bucket1/obj1
2017-01-13 03:45:25 +0000 CST 3998971ACAF94AD9AC48EAC1988BE863 oss://bucket1/obj2
2017-01-20 11:16:21 +0800 CST A20157A7B2FEC4670626DAE0F4C0073C oss://bucket1/tobj
UploadID Number is: 3
7) ossutil ls oss://bucket1/obj -m
InitiatedTime UploadID ObjectName
2017-01-13 03:45:26 +0000 CST 15754AF7980C4DFB8193F190837520BB oss://bucket1/obj1
2017-01-13 03:45:25 +0000 CST 3998971ACAF94AD9AC48EAC1988BE863 oss://bucket1/obj2
UploadID Number is: 2
8) ossutil ls oss://bucket1 -a
LastModifiedTime Size(B) StorageClass ETAG ObjectName
2015-06-05 14:06:29 +0000 CST 201933 Standard 7E2F4A7F1AC9D2F0996E8332D5EA5B41 oss://bucket1/dir1/obj11
2015-06-05 14:36:21 +0000 CST 201933 Standard 6185CA2E8EB8510A61B3A845EAFE4174 oss://bucket1/obj1
2016-04-08 14:50:47 +0000 CST 6476984 Standard 4F16FDAE7AC404CEC8B727FCC67779D6 oss://bucket1/sample.txt
Object Number is: 3
InitiatedTime UploadID ObjectName
2017-01-13 03:45:26 +0000 CST 15754AF7980C4DFB8193F190837520BB oss://bucket1/obj1
2017-01-13 03:43:13 +0000 CST 2A1F9B4A95E341BD9285CC42BB950EE0 oss://bucket1/obj1
2017-01-13 03:45:25 +0000 CST 3998971ACAF94AD9AC48EAC1988BE863 oss://bucket1/obj2
2017-01-20 11:16:21 +0800 CST A20157A7B2FEC4670626DAE0F4C0073C oss://bucket1/tobj
UploadID Number is: 4
9) ossutil ls oss://bucket1/obj -a
LastModifiedTime Size(B) StorageClass ETAG ObjectName
2015-06-05 14:36:21 +0000 CST 201933 Standard 6185CA2E8EB8510A61B3A845EAFE4174 oss://bucket1/obj1
Object Number is: 1
InitiatedTime UploadID ObjectName
2017-01-13 03:45:26 +0000 CST 15754AF7980C4DFB8193F190837520BB oss://bucket1/obj1
2017-01-13 03:43:13 +0000 CST 2A1F9B4A95E341BD9285CC42BB950EE0 oss://bucket1/obj1
2017-01-13 03:45:25 +0000 CST 3998971ACAF94AD9AC48EAC1988BE863 oss://bucket1/obj2
UploadID Number is: 3
10) ossutil ls oss://bucket1/obj -a -s
oss://bucket1/obj1
Object Number is: 1
UploadID ObjectName
15754AF7980C4DFB8193F190837520BB oss://bucket1/obj1
2A1F9B4A95E341BD9285CC42BB950EE0 oss://bucket1/obj1
3998971ACAF94AD9AC48EAC1988BE863 oss://bucket1/obj2
UploadID Number is: 3
11) ossutil ls oss://bucket1/obj -a -s --marker=obj1
Object Number is: 0
UploadID ObjectName
3998971ACAF94AD9AC48EAC1988BE863 oss://bucket1/obj2
UploadID Number is: 1
12) ossutil ls oss://bucket1/obj -a -s --limited-num=2
oss://bucket1/obj1
Object Number is: 1
UploadID ObjectName
15754AF7980C4DFB8193F190837520BB oss://bucket1/obj1
UploadID Number is: 1
13) ossutil ls oss://bucket1/%e4%b8%ad%e6%96%87 --encoding-type url
LastModifiedTime Size(B) StorageClass ETAG ObjectName
2017-03-17 17:34:40 +0800 CST 8345742 Standard BBCC8C0954B869B4A6B34D9404C5BCFD oss://bucket1/中文
Object Number is: 1
0.066567(s) elapsed
14) ossutil ls oss://bucket --include "*.avi" --include "*.mp4" --exclude "*.png" --exclude "*.jpg"
LastModifiedTime Size(B) StorageClass ETAG ObjectName
2019-05-30 14:23:51 +0800 CST 1030 Standard 4A902D176BE0EE4224BC196BBB8CCC69 oss://bucket/test.avi
2019-05-30 14:24:05 +0800 CST 1030 Standard 4A902D176BE0EE4224BC196BBB8CCC69 oss://bucket/test.mp4
Object Number is: 2
15) ossutil ls oss://bucket --all-versions
OPTIONS
-c, --config-file
ossutil工具的配置文件路径,ossutil启动时从配置文件读取配置,在config命令中,ossutil将配置写入该文件。
-e, --endpoint
ossutil工具的基本endpoint配置(该选项值会覆盖配置文件中的相应设置),注意其必须为一个二级域名。
-i, --access-key-id
访问oss使用的AccessKeyID(该选项值会覆盖配置文件中的相应设置)。
-k, --access-key-secret
访问oss使用的AccessKeySecret(该选项值会覆盖配置文件中的相应设置)。
-t, --sts-token
访问oss使用的STSToken(该选项值会覆盖配置文件中的相应设置),非必须设置项。
--proxy-host
网络代理服务器的url地址,支持http/https/socks5,比如 https://120.79.128.211:3128, socks5://120.79.128.211:1080
--proxy-user
网络代理服务器的用户名,默认为空
--proxy-pwd
网络代理服务器的密码,默认为空
--retry-times=10
当错误发生时的重试次数,默认值:10,取值范围:1-500
--loglevel
日志级别,默认为空,表示不输出日志文件,可选值为:info|debug,info输出提示信息日志,debug输出详细信息日志(包括http请求和响应信息)
--payer
请求的支付方式,如果为请求者付费模式,可以将该值设置成"requester"
-s, --short-format
显示精简格式,如果未指定该选项,默认显示长格式。
-d, --directory
返回当前目录下的文件和子目录,而非递归显示所有子目录下的所有object。
-m, --multipart
指定操作的对象为bucket中未完成的Multipart事件,而非默认情况下的object。
-a, --all-type
指定操作的对象为bucket中的object和未完成的Multipart事件。
--limited-num=-1
返回结果的最大个数。
--marker
列举Buckets时的marker,或列举objects或Multipart Uploads时的key marker, 或者其他有需要marker的地方。
--upload-id-marker
列举Multipart Uploads时的uploadID marker。
--encoding-type
输入或者输出的object名或文件名的编码方式,目前只支持url encode,即指定该选项时,取值范围为:url,如果不指定该选项,则表示object名或文件名未经过编码。bucket名不支持url encode。注意,如果指定了该选项,则形如oss://bucket/object的cloud_url,输入形式为:oss://bucket/url_encode(object),其中oss://bucket/字符串不需要编码。
--include
包含对象匹配模式,如:*.jpg
--exclude
不包含对象匹配模式,如:*.txt
--all-versions
表示object所有版本
--version-id-marker
表示列举objects所有版本的version id marker