全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

快速使用

最近更新时间:2026-10-08 14:10:53

概述

本文介绍使用 KS3Util 工具前,需要执行的初始化操作及常见操作。

前期准备

• 已获取 KS3 对应的 Region 及 Endpoint 信息,详情请参见Endpoint与Region的对应关系。

• 已获取 KS3 访问密钥(Access Key ID 和 Secret Access Key)信息,详情请参见开通KS3服务。

本文中的所有命令均以Linux或macOS系统为例,Windows系统的命令格式说明,详见KS3Util工具简介。

下载地址

  • 版本

    • 当前版本:2.18.0(注意2.x.x版本不兼容1.x.x版本的命令和配置,推荐使用2.x.x版本)

  • 运行环境

    • Windows、Linux、macOS

    • 支持架构:x86/AMD(64bit)、ARM(64bit)

  • 版本记录:下载地址

工具下载

1. Linux 版本
  1. 根据操作系统及架构下载对应版本,这里以Linux x86 64bit架构为例。

    curl -o ks3util https://ks3util-version-update.ks3-cn-beijing.ksyuncs.com/2.18.0/ks3util-linux-amd64

    其他架构或版本请访问下载地址页面获取。

  2. 执行以下命令,授予工具执行权限。

    chmod 755 ks3util
  3. 执行以下命令,若显示当前版本,则可以正常执行。

    ./ks3util -v

    ./表示通过指定相对路径来调用工具,也可以使用绝对路径。

  4. 将 ks3util 安装为全局命令(可选)。

    sudo mv ks3util /usr/local/bin/

    1. 安装后可在任意目录直接使用ks3util命令,可通过执行ks3util -v验证。

    2. 如需卸载,执行sudo rm /usr/local/bin/ks3util命令即可。

2. macOS 版本
  1. 根据操作系统及架构下载对应版本,这里以macOS arm 64bit架构为例。

    curl -o ks3util https://ks3util-version-update.ks3-cn-beijing.ksyuncs.com/2.18.0/ks3util-mac-arm

    其他架构或版本请访问下载地址页面获取。

  2. 执行以下命令,授予工具执行权限。

    chmod 755 ks3util
  3. 执行以下命令,若显示当前版本,则可以正常执行。

    ./ks3util -v

    1. ./表示通过指定相对路径来调用工具,也可以使用绝对路径。

    2. 在macOS上,若执行该操作时弹出无法验证的提示,需要在系统设置 -> 隐私与安全性中,选择仍然允许。授权完成后,再次执行该命令时,若弹出是否打开的提示,请选择仍要打开。

  4. 将 ks3util 安装为全局命令(可选)。

    sudo mv ks3util /usr/local/bin/

    1. 安装后可在任意目录直接使用ks3util命令,可通过执行ks3util -v验证。

    2. 如需卸载,执行sudo rm /usr/local/bin/ks3util命令即可。

3. Windows 版本
  1. 在下载地址页面中选择 Windows 版本下载。

    下载完成后,若浏览器下载页面中提示信任该文件,请在该文件的更多操作里选择保留,并在弹窗中点击显示详细信息,选择仍然保留。

  2. 在工具下载目录执行以下命令,若显示当前版本,则可以正常执行。

    .\ks3util.exe -v

    .\表示通过指定相对路径来调用工具,也可以使用绝对路径。

初始化配置

  1. 运行以下命令,生成并初始化配置文件。

    ./ks3util config

    Windows 版本需要执行 .\ks3util.exe config 命令。

  2. 根据提示信息,填写相应的配置。

    配置文件不存在,初始化配置:
        文件路径:/home/user/.ks3utilconfig
    
    对于以下配置,回车将跳过该配置项的设置:
    请输入accessKeyID:AK
    请输入accessKeySecret:SK
    请输入endpoint [ks3-cn-beijing.ksyuncs.com]:ks3-cn-beijing.ksyuncs.com
    
    配置文件初始化成功。

    1. 配置文件默认生成在~/.ks3utilconfig,后续命令自动读取。

    2. 若使用-c指定了非默认配置文件路径,后续命令也需通过-c指定该路径。

    3. 关于config命令的详细用法,请参见:管理配置文件(config)。

检查版本和连通性

配置完成后,您可以通过如下方式检查连通性,确认配置是否无误。

  • 使用-v选项查看工具版本

    ./ks3util -v
  • 返回结果如下:

    ks3util version: 2.18.0
  • 使用 ls 命令检查连通性

    # 该命令会返回当前账号的桶列表
    ./ks3util ls
  • 返回结果如下:

    CreationTime                                                   Region           StorageClass    BucketName
    2021-12-02 23:30:23.425 +0800 CST              BEIJING          NORMAL         ks3://bucket1
    2022-08-15 14:04:33.635 +0800 CST              BEIJING          NORMAL         ks3://bucket2
    Bucket Number is: 2
    
    0.117318(s) elapsed

运行示例

本文主要介绍使用 KS3Util 工具创建存储桶、上传文件、下载文件及删除文件的常见命令。

  1. 执行以下命令,创建一个名为 samplebucket 的存储桶。

    ./ks3util mb ks3://samplebucket 
  2. 执行以下命令,将 file.txt 文件上传至 samplebucket 存储桶。

    # 上传单个对象
    ./ks3util cp /temp/file.txt ks3://samplebucket/file.txt
  3. 执行以下命令,将 samplebucket 存储桶中的 file.txt 文件下载至本地。

    # 下载单个对象
    ./ks3util cp ks3://samplebucket/file.txt /temp/file.txt
  4. 执行以下命令,删除 samplebucket 存储桶中的 file.txt 文件。

    # 删除单个对象
    ./ks3util rm ks3://samplebucket/file.txt

    使用rm命令删除对象时,工具会提示您输入 y/n 进行二次确认,如果您希望强制删除,可以添加 -f 参数,详细说明请参见 rm 命令。

  5. 执行以下命令,将 test_folder 文件夹下的文件上传至 samplebucket 存储桶。

    # 上传文件夹
    ./ks3util cp /temp/test_folder ks3://samplebucket -r

    默认仅上传文件夹内的文件,不上传文件夹本身。如需上传文件夹,请在目标路径中增加文件夹名称(参考示例6)。

  6. 执行以下命令,将 test_folder 文件夹上传至 samplebucket 存储桶。

    # 上传文件夹
    ./ks3util cp /temp/test_folder ks3://samplebucket/test_folder/ -r
  7. 执行以下命令,将 samplebucket 存储桶中的 test_folder 文件夹下的文件下载至本地。

    # 下载文件夹
    ./ks3util cp ks3://samplebucket/test_folder/ /temp -r

    默认仅下载文件夹内的文件,不下载文件夹本身。如需下载文件夹,请在目标路径中增加文件夹名称(参考示例8)。

  8. 执行以下命令,将 samplebucket 存储桶中的 test_folder 文件夹下载至本地。

    # 下载文件夹
    ./ks3util cp ks3://samplebucket/test_folder/ /temp/test_folder -r
  9. 执行以下命令,删除 samplebucket 存储桶中的 test_folder 文件夹。

    # 删除文件夹
    ./ks3util rm ks3://samplebucket/test_folder/ -r

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈