金山云-文档中心-辅助命令

对象存储(KS3)

查看更多结果

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

页面目录

全部展开全部收起

产品更新动态

未找到含该关键词的产品

文档中心

对象存储(KS3)

常用工具

工具汇总

KS3Util命令行工具

辅助命令

最近更新时间：2025-02-25 15:35:31

概述

本文为您介绍KS3Util的辅助命令。

设置配置文件（config）

config命令用于创建配置文件，存储KS3访问信息，在使用其他命令时添加-c选项，KS3Util将通过指定的配置来访问KS3。

命令格式

该命令有交互式和非交互式两种用法。交互式用法为用户根据提示输入相应信息，命令结束时生成配置文件。非交互式则需要通过选项来指定需要的配置项。相比非交互式用法，交互式用法具有更高的安全性。

如果使用命令时输入了除-L，--languange和-c，--config-file以外的任意选项，则进入非交互式模式，所有的配置项需通过选项来指定。

./ks3util config 
[-e, --endpoint <value>] 
[-i, --access-key-id <value>] 
[-k, --access-key-secret <value>] 
[-L, --language <value>] 
[--output-dir <value>] 
[-c, --config-file <value>]

参数说明

参数	说明
-e, --endpoint	KS3Util工具的基本endpoint配置（该选项值会覆盖配置文件中的相应设置），注意其必须为一个二级域名，如：ks3-cn-beijing.ksyuncs.com。
-i, --access-key-id	访问ks3使用的AccessKeyID（该选项值会覆盖配置文件中的相应设置）。
-k, --access-key-secret	访问ks3使用的AccessKeySecret（该选项值会覆盖配置文件中的相应设置）。
-L, --language	指定语言。CH（默认值）：中文。EN：英文。设置为CH时，请确保系统编码方式为UTF-8。
--output-dir	指定输出文件所在的目录，输出文件目前包含：cp命令批量拷贝文件出错时所产生的report文件。默认值为：当前目录下的ks3util_output目录。
-c, --config-file	KS3Util工具的配置文件路径，KS3Util启动时从配置文件读取配置，在config命令中，KS3Util将配置写入该文件。

使用示例

示例一：交互式用法

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

请输入配置文件名，文件名可以带路径(默认为：/home/user/.ks3utilconfig，回车将使用默认配置文件。如果用户设置为其它文件，在使用命令时需要将--config-file选项设置为该文件）：my_ks3util.conf
对于下述配置，回车将跳过相关配置项的设置，配置项的具体含义，请使用"help config"命令查看。
请输入语言(CH/EN，默认为：CH，该配置项将在此次config命令成功结束后生效)：CH
请输入endpoint：ks3-cn-beijing.ksyuncs.com
请输入accessKeyID：my-access-key-id
请输入accessKeySecret：my-access-key-secret

示例二：非交互式用法

./ks3util config -e ks3-cn-beijing.ksyuncs.com -i my-access-key-id -k my-access-key-secret -L CH -c my_ks3util.conf

编辑配置文件
对于已经生成的配置文件，也可以通过直接修改配置文件来修改KS3访问信息。KS3Util工具的配置文件格式如下：

[Credentials]
    language = CH
    endpoint = ks3-cn-beijing.ksyuncs.com
    accessKeyID = your_key_id
    accessKeySecret = your_key_secret
    outputDir = your_output_dir

测试网络速率（probe）

probe 命令，用于测试上传、下载速度，测试本地是否存在软链接循环问题。

命令格式

./ks3util probe ks3://bucketname[/prefix]
[--probe-type <value>] 
[--probe-file <value>] 
[--probe-runtime <value>]
[-j, --jobs <value>]

参数说明

参数	说明
bucketname	操作的桶名。
prefix	操作的对象的前缀。
--probe-type	upload：探测上传带宽（默认值）。 download：探测下载带宽。 cycle-symlink：探测本地是否存在异常软链接。
--probe-file	测试上传速度时：该参数表示本地上传文件的路径，未配置则会从内存生成数据上传。测试下载速度时：该参数表示下载后文件保存的本地目录，未配置则下载数据不保存。
--probe-runtime	测速执行时间。默认值：30秒，最小值：10秒。
-j, --jobs	测速时文件上传/下载的并发数，默认值为cpu数。取值范围：1-10000。

使用示例

示例一：探测上传速度，在内存中生成数据上传，测试数据上传到samplebucket的probe-prefix/目录下，测试结束后删除上传的文件。
```
./ks3util probe ks3://samplebucket/probe-prefix/ --probe-type upload
```
示例二：探测上传速度，上传指定本地文件/root/test/file，测试数据上传到samplebucket的probe-prefix/目录下，测试结束后删除上传的文件。
```
./ks3util probe ks3://samplebucket/probe-prefix/ --probe-type upload --probe-file /root/test/file
```
示例三：探测上传速度，设置执行时间，测试数据上传到samplebucket的probe-prefix/目录下，测试结束后删除上传的文件。
```
./ks3util probe ks3://samplebucket/probe-prefix/ --probe-type upload --probe-runtime 30
```
示例四：探测上传速度，设置并发数，测试数据上传到samplebucket的probe-prefix/目录下，测试结束后删除上传的文件。
```
./ks3util probe ks3://samplebucket/probe-prefix/ --probe-type upload --jobs 10
```
示例五：探测下载速度，下载数据不保存，测试下载samplebucket中的probe-object文件。
```
./ks3util probe ks3://samplebucket/probe-object --probe-type download
```
示例六：探测下载速度，下载数据保存到本地/root/test/dir/文件夹下，测试下载samplebucket中的probe-object文件，测试结束后删除下载的文件。
```
./ks3util probe ks3://samplebucket/probe-object --probe-type download --probe-file /root/test/dir/
```
示例七：探测下载速度，设置执行时间，测试下载samplebucket中的probe-object文件。
```
./ks3util probe ks3://samplebucket/probe-object --probe-type download --probe-runtime 30
```
示例八：探测下载速度，设置并发数，测试下载samplebucket中的probe-object文件。
```
./ks3util probe ks3://samplebucket/probe-object --probe-type download --jobs 10
```
示例九：探测本地目录是否存在软连接指向死循环的问题
```
./ks3util probe /root/test/dir/ --probe-type cycle-symlink
```

帮助信息（help）

help命令用来获取命令的帮助信息，当不清楚某个命令的用法时，建议使用help命令获取该命令的帮助信息。

命令格式

./ks3util help [command]

使用示例

获取KS3Util支持的所有命令
```
./ks3util help
```
查看所有选项信息
```
./ks3util help -h
```
查看某个命令的帮助信息，如：cp命令
```
./ks3util help cp
```

计算CRC或MD5（hash）

hash命令用于计算本地文件的CRC64或MD5值。

命令格式

./ks3util hash localfile [--type <value>]

参数说明

参数

说明

localfile

本地文件的完整路径。

--type

数据完整性校验算法类型，可选值有crc64|md5。

crc64（默认）：计算本地文件的CRC64值。
md5：计算本地文件的MD5值。取值为MD5时，会同时输出文件的MD5以及Content-MD5值。Content-MD5值是在计算MD5值获得128比特位数字的基础上，对该数字进行base64编码。关于Content-MD5的更多信息，请参见RFC1864。

您可以通过stat命令中返回的Content-Md5和X-Kss-Checksum-Crc64ecma分别获取KS3内文件的Content-MD5和CRC64值。

在KS3支持CRC64校验之前上传至Bucket内的文件，不支持通过stat命令查看文件的CRC64值。

对于通过分块上传或追加上传方式上传的文件，不支持通过stat命令查看文件的Content-MD5值。

使用示例

计算本地文件localfile.txt的CRC64值

./ks3util hash localfile.txt --type crc64

计算本地文件localfile.txt的MD5值
```
./ks3util hash localfile.txt --type md5
```

更新版本（update）

update命令用于KS3Util更新版本。该命令会联网检查是否有新版本，如果有新版本，则询问是否进行更新；如果指定了–force选项，则不询问。

命令格式

./ks3util update [-f, --force]

参数说明

参数	说明
-f, --force	强制操作，不进行询问提示。

使用示例

./ks3util update
当前版本为：1.0.0，最新版本为：2.0.0
确定更新版本(y or N)? y
更新成功!

文档导读

上一篇：对象操作

下一篇：通用选项&过滤规则

纯净模式常规模式

纯净模式

点击可全屏预览文档内容