全部产品
Search
文档中心

对象存储 OSS:命令行工具ossutil快速入门

更新时间:Nov 01, 2024

ossutil是阿里云官方提供的OSS命令行管理工具。首次使用时您需要先创建存储空间,将本地文件上传到存储空间。上传完成后,可以按需将文件下载至本地,或者通过生成预签名URL的方式将文件分享给第三方,供其下载或预览。

前提条件

操作步骤

ossutil 2.0相较于1.0而言,采用了全新的命令组织形式,在配置文件、访问凭证、过滤参数等诸多方面都发生了变化。如果您是ossutil新用户,建议使用ossutil 2.0版本。

ossutil 2.0(预览版)快速入门

步骤一:安装ossutil

Linux

  1. 下载ossutil安装包。

    curl -o ossutil-2.0.4-beta.10251600-linux-amd64.zip https://gosspublic.alicdn.com/ossutil/v2-beta/2.0.4-beta.10251600/ossutil-2.0.4-beta.10251600-linux-amd64.zip
    说明

    此处以Linux x86 64bit为例进行介绍。其他系统下载地址,请参见安装ossutil

  2. 在下载压缩包的所在目录执行以下解压命令。

    unzip ossutil-2.0.4-beta.10251600-linux-amd64.zip
  3. 进入ossutil-2.0.4-beta.10251600-linux-amd64目录。

    cd ossutil-2.0.4-beta.10251600-linux-amd64
  4. 在当前目录执行以下命令。

    chmod 755 ossutil
  5. 执行以下命令,如果能返回版本号,说明安装成功。

    ossutil version

Windows

  1. 根据您电脑的配置点击Windows x86 32bitWindows x86 64bit下载安装包。

  2. 解压已下载的Windows安装包。

  3. 在命令行中进入ossutil-v1.7.19-windows-amd64目录。

    cd ossutil-v1.7.19-windows-amd64

macOS

  1. 下载ossutil安装包。

    curl -o ossutil-2.0.4-beta.10251600-mac-arm64.zip  https://gosspublic.alicdn.com/ossutil/v2-beta/2.0.4-beta.10251600/ossutil-2.0.4-beta.10251600-mac-arm64.zip
    说明

    此处以macOS ARM 64bit为例进行介绍。其他系统下载地址,请参见安装ossutil

  2. 在下载压缩包的所在目录执行以下解压命令。

    unzip ossutil-2.0.4-beta.10251600-mac-arm64.zip
  3. 进入ossutil-2.0.4-beta.10251600-mac-arm64目录。

    cd ossutil-2.0.4-beta.10251600-mac-arm64
  4. 执行以下命令。

    chmod 755 ossutil
  5. 继续执行以下命令,如果能返回版本号,说明安装成功。

    ossutil version

步骤二:配置ossutil

  1. 输入配置命令。

    ossutil config
  2. 设置配置文件路径。

    Please enter the config file name,the file name can include path(default /root/.ossutilconfig, carriage return will use the default file. If you specified this option to other file, you should specify --config-file option to the file when you use other commands):

    建议直接回车使用默认配置,默认值为/root/.ossutilconfig。

  3. 根据提示分别设置AccessKey ID、AccessKey Secret、地域等信息。

    输入您创建的AccessKey ID。

    Please enter Access Key ID [None]:

    输入您创建的AccessKey Secret。

    Please enter Access Key Secret [None]:

    输入您的OSS的数据中心所在的地域,如无任何输入,默认值为cn-hangzhou。

    Please enter Region [cn-hangzhou]:
  4. 验证是否安装并配置成功

    ossutil

    如果屏幕中输出ossutil所有支持的命令,表明已成功安装并配置好ossutil。

步骤三:创建存储空间

创建名为examplebucket的存储空间。

ossutil mb oss://examplebucket

以下输出结果表明已成功创建examplebucket。

0.668238(s) elapsed

步骤四:上传文件

  1. 下载示例文件exampleobject.jpg到本地。

  2. 将刚才下载的示例文件上传至目标存储空间examplebucket。

    ossutil cp exampleobject.jpg oss://examplebucket

    以下输出结果表明文件已成功上传至目标Bucket。

    Success: Total 1 file, size 2078 B, Upload done:(1 objects, 2078 B), avg 5.985 KiB/s
    0.344043(s) elapsed

步骤五:下载文件

将已上传的示例文件exampleobject.jpg从目标存储空间examplebucket下载至本地localfolder文件夹下。

ossutil cp oss://examplebucket/exampleobject.jpg localfolder/

以下输出结果表明文件已成功下载至本地目标文件夹。

Success: Total 1 object, size 13 B, Download done:(1 files, 13 B), avg 86 B/s
0.154553(s) elapsed

步骤六:分享文件

对目标文件oss://examplebucket/exampleobject.jpg生成默认有效期为15分钟的预签名URL。

ossutil presign oss://examplebucket/exampleobject.jpg

以下输出结果表明已成功生成文件的预签名URL。

https://examplebucket.oss-cn-hangzhou.aliyuncs.com/exampleobject.jpg?x-oss-credential=LTAI5tAC9X28MocRaycC****%2F20240912%2Fcn-hangzhou%2Foss%2Faliyun_v4_request&x-oss-date=20240912T092928Z&x-oss-expires=900&x-oss-signature=fe72a66bf42cc619023e9ae289882a4d2443870b616ae1fba17eb81bb02a****&x-oss-signature-version=OSS4-HMAC-SHA256
0.002727(s) elapsed

将该预签名URL复制到浏览器地址栏打开即可访问该文件。

步骤七:释放资源

由于阿里云OSS采用按量计费,文件保留期间会持续产生费用。为防止上传的文件后续产生额外费用,请在操作结束后释放资源。

  • 删除文件

    删除examplebucket下名为exampleobject.jpg的示例文件。

    ossutil rm oss://examplebucket/exampleobject.jpg

    以下输出结果表明已成功删除。

    0.295530(s) elapsed
  • 删除存储空间

    删除空的存储空间examplebucket。

    ossutil rb oss://examplebucket

    以下输出结果表明已成功删除存储空间。

    0.478659(s) elapsed

至此,您应该已经入门了ossutil2.0的使用,如需了解更多信息,可参阅命令行工具ossutil 2.0(预览版)

ossutil 1.0快速入门

步骤一:安装ossutil

Linux

  1. 安装unzip解压工具。

    sudo yum install -y unzip
  2. 安装ossutil。

    sudo -v ; curl https://gosspublic.alicdn.com/ossutil/install.sh | sudo bash
    说明

    默认安装到/usr/bin目录下。

Windows

  1. 根据您电脑的配置点击Windows x86 64bitWindows x86 32bit下载安装包。

  2. 将工具解压,并双击运行ossutil.bat文件。

macOS

安装ossutil。

sudo -v ; curl https://gosspublic.alicdn.com/ossutil/install.sh | sudo bash
说明

默认安装到/usr/local/bin目录下。

步骤二:配置ossutil

  1. 输入配置命令。

    ossutil config
  2. 设置配置文件路径。

    Please enter the config file name,the file name can include path(default /root/.ossutilconfig, carriage return will use the default file. If you specified this option to other file, you should specify --config-file option to the file when you use other commands):

    此处可直接回车使用默认配置文件,默认值为/root/.ossutilconfig。

  3. 根据提示设置工具的语言。请输入语言CHEN。工具使用的语言默认与操作系统保持一致。该配置项将在此次config命令设置成功后生效,建议输入CH

  4. 根据提示分别设置AccessKey ID、AccessKey Secret、地域和STSToken等参数信息。

    输入您创建的AccessKey ID。

    Please enter Access Key ID:

    输入您创建的AccessKey Secret。

    Please enter Access Key Secret:

    输入您的OSS的数据中心所在的地域,如华东1(杭州)地区输入cn-hangzhou

    Please enter Region:

    输入您的临时身份凭证,建议直接回车,stsToken设置为空。

    Please enter stsToken:
  5. 验证是否安装成功

    ossutil

    如果屏幕中输出ossutil所有支持的命令,表明已成功安装ossutil。

步骤三:创建存储空间

创建名为examplebucket的存储空间。

ossutil mb oss://examplebucket

以下输出结果表明已成功创建examplebucket。

0.668238(s) elapsed

步骤四:上传文件

  1. 下载示例文件exampleobject.jpg到本地。

  2. 将刚才下载的示例文件上传至目标存储空间examplebucket。

    ossutil cp exampleobject.jpg oss://examplebucket
    0.720812(s) elapsed

步骤五:下载文件

将已上传的示例文件exampleobject.jpg从目标存储空间examplebucket下载至本地localfolder文件夹下。

ossutil cp oss://examplebucket/exampleobject.jpg localfolder/

以下输出结果表明文件已成功下载至本地目标文件夹。

0.154553(s) elapsed

步骤六:分享文件

对目标文件oss://examplebucket/exampleobject.jpg生成超时时间为3600秒的文件签名URL。

ossutil sign oss://examplebucket/exampleobject.jpg --timeout 3600 

以下输出结果表明已成功生成文件签名URL。

https://examplebucket.oss-cn-hangzhou.aliyuncs.com/exampleobject.jpg?Expires=1608282224&OSSAccessKeyId=LTAI4G33piUmgRN1DXx9****&Signature=jo4%2FGykfuc1A4fvyvKRpRyymYH**** 0.368676(s) elapsed

将该签名URL复制到浏览器地址栏打开即可访问该文件。

步骤七:释放资源

由于阿里云OSS采用按量计费,文件保留期间会持续产生费用。为防止上传的文件后续产生额外费用,请在操作结束后释放资源。

  • 删除文件

    删除examplebucket下名为exampleobject.jpg的示例文件。

    ossutil rm oss://examplebucket/exampleobject.jpg

    以下输出结果表明已成功删除。

    0.295530(s) elapsed
  • 删除存储空间

    删除空的存储空间examplebucket。

    ossutil rb oss://examplebucket

    以下输出结果表明已成功删除存储空间。

    0.478659(s) elapsed

至此,您应该已经入门了ossutil1.0的使用,如需了解更多信息,可参阅命令行工具ossutil 1.0