金山云-文档中心-KS3 Util快速入门

对象存储(KS3)

查看更多结果

未找到含当前关键字的文档标题

页面目录

全部展开全部收起

产品更新动态

未找到含该关键词的产品

文档中心

对象存储(KS3)

常用工具

工具汇总

KS3Util命令行工具

KS3Util快速入门

最近更新时间：2025-04-29 14:25:58

概述

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

前期准备

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

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

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

工具下载

版本
- 当前版本：2.10.0（注意2.x.x版本不兼容1.x.x版本指令和配置，推荐使用2.x.x版本）
运行环境
- Windows、Linux、macOS
- 支持架构：x86/AMD(64bit)、ARM(64bit)
下载地址：下载地址

初始化配置

1.在Linux、macOS上使用

根据操作系统及架构下载对应版本。
1. Linux：使用wget命令指定下载链接下载。
2. macOS：直接在下载页面下载。(如果您已安装wget，推荐使用该命令下载)
假设下载的文件为~/Downloads/ks3util，在终端中运行以下命令进入下载目录。
```
cd ~/Downloads/
```
运行以下命令授予文件执行权限。
```
chmod 755 ks3util
```
运行以下命令，验证KS3Util是否可以正常执行。若输出KS3Util命令用法，则表明可以正常执行。
```
./ks3util
```
在macOS上，执行该操作若弹出无法验证的提示，需要在系统设置 -> 隐私与安全性中，选择仍然允许。授权完成后，再次执行该命令，若弹出是否打开的提示，请选择仍要打开。
运行以下命令，生成并初始化KS3Util配置文件。
```
./ks3util config
```

根据提示信息，填写相应的配置。

该命令创建将一个配置文件，在其中存储配置信息。

请输入配置文件名,文件名可以带路径(默认为：/home/user/.ks3utilconfig，回车将使用默认配置文件。如果用户设置为其它文件，在使用命令时需要将--config-file选项设置为该文件）：
未输入配置文件，将使用默认配置文件：/home/user/.ks3utilconfig。

对于下述配置，回车将设置相关配置项为原值或默认值，配置项的具体含义，请使用"help config"命令查看。
请输入语言(CH/EN，默认为：CH，该配置项将在此次config命令成功结束后生效)：CH
请输入accessKeyID：AK
请输入accessKeySecret：SK
请输入endpoint [ks3-cn-beijing.ksyuncs.com]：ks3-cn-beijing.ksyuncs.com
请输入loglevel：info

1. 若不指定配置文件生成路径，则默认生成在~目录下，假设您的用户名是user，那么~通常会解析为/home/user（Linux）或/Users/user（macOS）。若您是root用户，则~默认指向/root（Linux）或/var/root（macOS）。后续执行命令时，KS3Util会自动读取默认路径下的配置。

2. 若指定了配置文件生成路径，则会在指定的路径下生成配置文件，因此后续执行命令时，需要使用-c选项指定配置文件路径，如果不使用-c选项，KS3Util依旧会从默认路径下读取配置。

2.在Windows上使用

选择Windows版本下载。
下载完成后，若浏览器下载页面中提示信任该文件，请在该文件的更多操作里选择保留，并在弹窗中点击显示详细信息，选择仍然保留。
假设下载的文件为D:\Downloads\ks3util.exe，打开cmd运行以下命令进入下载目录。
```
cd D:\Downloads\
```
运行以下命令，验证KS3Util是否可以正常执行。若输出KS3Util命令用法，则表明可以正常执行。
```
.\ks3util.exe
```
运行以下命令，生成并初始化KS3Util配置文件。
```
.\ks3util.exe config
```

根据提示信息，填写相应的配置。

该命令创建将一个配置文件，在其中存储配置信息。

请输入配置文件名,文件名可以带路径(默认为：C:\\Users\Administrator\.ks3utilconfig，回车将使用默认配置文件。如果用户设置为其它文件，在使用命令时需要将--config-file选项设置为该文件）：
未输入配置文件，将使用默认配置文件：C:\\Users\Administrator\.ks3utilconfig。

对于下述配置，回车将设置相关配置项为原值或默认值，配置项的具体含义，请使用"help config"命令查看。
请输入语言(CH/EN，默认为：CH，该配置项将在此次config命令成功结束后生效)：CH
请输入accessKeyID：AK
请输入accessKeySecret：SK
请输入endpoint [ks3-cn-beijing.ksyuncs.com]：ks3-cn-beijing.ksyuncs.com
请输入loglevel：info

1. 若不指定配置文件生成路径，则默认生成在~目录下，假设您的用户名是Administrator，那么~通常会解析为C:\\Users\Administrator。后续执行命令时，KS3Util会自动读取默认路径下的配置。

检查版本和连通性

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

使用version命令检查工具的版本
```
# 检查工具版本
./ks3util -v
```
返回结果如下：
```
ks3util version: 2.10.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 工具创建存储桶、上传文件、下载文件及删除文件的常见命令。

执行以下命令，创建一个命名为 samplebucket 的存储桶。
```
./ks3util mb ks3://samplebucket 
```

执行以下命令，将 file.txt 文件上传至 samplebucket 存储桶。

# 上传单个对象
./ks3util cp /temp/file.txt ks3://samplebucket/file.txt

执行以下命令，将 samplebucket 存储桶中的 file.txt 文件下载至本地。
```
# 下载单个对象
./ks3util cp ks3://samplebucket/file.txt /temp/file.txt
```
执行以下命令，删除 bucketname 存储桶中的 file.txt 文件。
```
# 删除单个对象
./ks3util rm ks3://samplebucket/file.txt
```
使用rm命令删除对象时，工具会提示您输入 y/n 进行二次确认，如果您希望强制删除，可以添加 -f 参数，详细说明，请参见 rm 命令。
执行以下命令，将 test_folder 文件夹上传至 samplebucket 存储桶。
```
# 上传文件夹
./ks3util cp /temp/test_folder ks3://samplebucket -r
```
执行以下命令，将 samplebucket 存储桶中的 test_folder 文件夹下载至本地。
```
# 下载文件夹
./ks3util cp ks3://samplebucket/test_folder /temp -r
```
执行以下命令，删除samplebucket 存储桶中的 test_folder 文件夹。
```
# 删除文件夹
./ks3util rm ks3://samplebucket/test_folder -r
```

文档导读

上一篇：KS3Util简介

下一篇：桶操作

纯净模式常规模式

纯净模式

点击可全屏预览文档内容