ossutil是以命令行方式管理OSS数据的工具,提供方便、简洁、丰富的Bucket和Object管理命令,支持Windows、Linux、 Mac平台。

下载地址

快速安装

根据您的操作系统选择相应的binary或者压缩包,下载后运行相应的binary。
  • Linux系统(以64位系统为例)
    1. 下载工具:
      wget http://gosspublic.alicdn.com/ossutil/1.5.2/ossutil64
      								
    2. 修改文件执行权限:
      chmod 755 ossutil64
    3. 使用交互式配置生成配置文件:
      ./ossutil64 config
      该命令创建将一个配置文件,在其中存储配置信息。 请输入配置文件路径(默认为:/home/user/.ossutilconfig,回车将使用默认路径。如果用户设置为 其它路径,在使用命令时需要将--config-file选项设置为该路径): 
      未输入配置文件路径,将使用默认配置文件:/home/user/.ossutilconfig。 
      对于下述配置,回车将跳过相关配置项的设置,配置项的具体含义,请使用"help config"命令查看。 
      请输入endpoint:http://oss-cn-shenzhen.aliyuncs.com 
      请输入accessKeyID:yourAccessKeyID 
      请输入accessKeySecret:yourAccessKeySecret
      请输入stsToken: 
  • Windows系统(以64位系统为例):
    1. 下载工具。
    2. 将工具解压到指定的文件夹,并双击运行ossutil.bat文件。
    3. 生成配置文件,配置参数参考Linux系统的配置参数:
      D:\ossutil>ossutil64.exe config
  • Mac系统(以64位系统为例):
    1. 下载工具。
      curl -o ossutilmac64 http://gosspublic.alicdn.com/ossutil/1.5.2/ossutilmac64
    2. 修改文件执行权限:
      chmod 755 ossutilmac64
    3. 生成配置文件,配置参数参考Linux系统的配置参数:
      ./ossutilmac64 config

快速使用

下面介绍一些常用命令。

  • 获取命令列表:
    ./ossutil help
    					
  • 查看某命令的帮助文档:
    ./ossutil help cmd
    例如:
    ./ossutil  help config
    					
  • 输出ossutil日志文件

    ossutil从1.4.3版本开始,支持在使用ossutil的命令时,搭配--loglevel=${level}选项,在当前工作目录下输出ossutil日志文件ossutil.log。该值默认为空,表示不输出日志文件,可选值为info/debug。

    • 默认级别:该参数默认为空,表示不输出日志文件。
    • info级别:用于打印ossutil操作记录。
      ./ossutil [command] --loglevel=info
    • debug级别:可以输出http流水日志以及原始签名串信息,方便定位问题。
      ./ossutil [command] --loglevel=debug
  • 获取ossutil版本号:
    ./ossutil --version
  • 设置ossutil的语言
    在使用ossutil的命令时,可以使用-L选项设置语言,可选值为CH/EN,即:中文或英文,大小写不敏感,默认语言为CH(中文)。如果设置为CH(中文),需要确保您的系统为utf-8编码,否则可能会显示乱码。
    • 设置ossutil的语言为中文:
      ./ossutil config -L ch
      注意 若已经生成配置文件,此命令会重新设置配置文件参数。
    • 使用默认语言显示ls命令的帮助:
      ./ossutil help ls
    • 切换为中文显示ls命令的帮助:
      ./ossutil help ls -L ch
    说明 ossutil输出的错误提示默认都为英文,无法修改。
  • 修改配置文件

    管理不同地域的Bucket时,需要修改配置信息,您可以通过以下方式修改:

    • 指定配置文档
      ./ossutil config -c your_config_file_path
      							

      配置文档内容格式如下:

      [Credentials]
          language = CH 
          endpoint = oss-cn-xxx.aliyuncs.com
          accessKeyID = your_key_id
          accessKeySecret = your_key_secret
          stsToken = your_sts_token
          outputDir = your_output_dir
      [Bucket-Endpoint]
          bucket1 = endpoint1
          bucket2 = endpoint2
          ...
      [Bucket-Cname]
          bucket1 = cname1
          bucket2 = cname2
          ...
      							
      • Bucket-Endpoint : 对每个指定的Bucket单独配置Endpoint。如果配置了Bucket-Endpoint选项,当对某Bucket进行操作时,ossutil会在该选项中查找该Bucket对应的Endpoint。如果找到,将会使用该Endpoint管理对应Bucket;若没有找到,则使用基本配置的Endpoint。
        说明 您可以通过设置Endpoint选择与OSS的交互方式。
        • Endpoint设置为oss-cn-xxx.aliyuncs.comhttp://oss-cn-xxx.aliyuncs.com时,使用Http方式交互。
        • Endpoint设置为https://oss-cn-xxx.aliyuncs.com时,使用Https方式交互。
      • Bucket-Cname : 对每个指定的Bucket单独配置CDN加速域名。如果配置了Bucket-Cname选项,当对某Bucket进行操作时,ossutil会在该选项中查找该Bucket对应的CDN加速域名,如果找到,该域名将会覆盖Bucket-Endpoint选项和基本配置中的Endpoint。关于CDN域名详情请参考CDN加速OSS
      • 优先级说明:--endpoint(命令参数) > Bucket-Cname > Bucket-Endpoint > endpoint(基本配置) > 默认endpoint
    • 交互式配置
      ./ossutil config
      该命令创建将一个配置文件,在其中存储配置信息。
      请输入配置文件路径(默认为:/home/user/.ossutilconfig,回车将使用默认路径。如果用户设置为	其它路径,在使用命令时需要将--config-file选项设置为该路径):
      未输入配置文件路径,将使用默认配置文件:/home/user/.ossutilconfig。
      对于下述配置,回车将跳过相关配置项的设置,配置项的具体含义,请使用"help config"命令查看。
      请输入stsToken:
      请输入endpoint:http://oss-cn-xxx.aliyuncs.com
      请输入accessKeyID:yourAccessKeyID
      请输入accessKeySecret:yourAccessKeySecret
      							
    • 非交互式配置
      ./ossutil config -e endpoint -i your_id -k your_secret
      							
    • 配置选项
      -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。
      --output-dir=ossutil_output
          指定输出文件所在的目录,输出文件目前包含:cp命令批量拷贝文件出错时所产生的report文件。
      -L CH, --language=CH
          设置ossutil工具的语言,默认值:CH,取值范围:CH/EN,若设置成"CH",请确保您的系统编码为UTF-8。

参考文档