全部文档
当前文档
最近更新时间：2026-10-08 14:10:48
config 命令用于创建和编辑配置文件，存储访问 KS3 所需的配置信息。ks3util 执行其他命令时默认从 ~/.ks3utilconfig 读取访问信息，可用 -c 指定其他路径的配置文件。
配置文件以 [profile name] 段组织多组配置，可为不同环境、不同账号分别建立 profile，执行命令时用 --profile 指定使用哪一组，未指定时默认使用 default。
config 命令围绕多组配置提供以下子功能：
管理默认配置：创建或编辑 [profile default]。
管理多配置：新增或编辑指定名称的配置。
读写配置项：对指定配置的单个配置项进行设置、查询、删除。
查看配置：输出配置文件或单个配置的内容。
本文所述功能需 2.18.0 及以上版本支持，如您的版本较低，请升级后使用。
不带子命令直接运行 config，用于创建或编辑默认配置（[profile default]）。
逐项询问配置项，回车跳过或保留原值。编辑已有配置时，原文件会自动备份为 .bak。
./ks3util config [-c <value>] [-f]参数 | 说明 |
|---|---|
-c | 指定配置文件路径，未指定时默认 |
-f | 配置文件格式不合法时，备份原文件为 |
首次生成默认配置。
./ks3util config输出示例：
配置文件不存在，初始化配置：
文件路径：/home/user/.ks3utilconfig
对于以下配置，回车将跳过该配置项的设置：
请输入accessKeyID：AK
请输入accessKeySecret：SK
请输入endpoint [ks3-cn-beijing.ksyuncs.com]：ks3-cn-beijing.ksyuncs.com
配置文件初始化成功。配置完成后，配置文件内容如下：
[profile default]
accessKeyID = AK
accessKeySecret = SK
endpoint = ks3-cn-beijing.ksyuncs.com配置文件以 [profile name] 段组织，可为不同环境或账号分别建立多个配置，例如：
[profile default]
accessKeyID = AK
accessKeySecret = SK
endpoint = ks3-cn-beijing.ksyuncs.com
[profile dev]
accessKeyID = devAK
accessKeySecret = devSK
endpoint = ks3-cn-shanghai.ksyuncs.com若在命令中传入了 -e/-i/-k 等非空配置值，则进入非交互模式，将所传值直接写入默认配置。
./ks3util config [options]可用的写入选项：
选项 | 说明 |
|---|---|
-e, --endpoint | KS3 的 endpoint，须为二级域名，如 |
-i, --access-key-id | 访问 KS3 使用的 AccessKeyID。 |
-k, --access-key-secret | 访问 KS3 使用的 AccessKeySecret。 |
-t, --sts-token | 临时访问凭证 Token，使用临时 AK 访问 KS3 时配置。 |
-L, --language | 指定语言， |
-c, --config-file | 配置文件路径，未指定时默认 |
./ks3util config -e ks3-cn-beijing.ksyuncs.com -i AK -k SK -c ks3util.conf为不同环境或账号分别建立配置，使用 config profile 子命令交互式新增或编辑。
./ks3util config profile [name] [-c <value>] [-f]配置名作为位置参数给出，省略时交互输入。
已存在的同名配置会读出当前值供按需修改，其他配置不受影响。
配置名不能含英文逗号。
参数 | 说明 |
|---|---|
name | 配置名称，作为位置参数给出，省略时交互输入。 |
-c | 指定配置文件路径，未指定时默认 |
-f | 配置文件格式不合法时，备份原文件为 |
不带配置名，交互式输入。
./ks3util config profile输出示例：
请输入配置名：dev
配置文件已存在，新增配置：
文件路径：/home/user/.ks3utilconfig
对于以下配置，回车将跳过该配置项的设置：
请输入accessKeyID：devAK
请输入accessKeySecret：devSK
请输入endpoint [ks3-cn-beijing.ksyuncs.com]：ks3-cn-shanghai.ksyuncs.com
配置文件更新成功。新增或编辑名为 dev 的配置。
./ks3util config profile dev新增/编辑完成后，执行其他命令时用 --profile 指定使用哪个配置。
./ks3util ls ks3://bucket --profile dev对指定配置的单个配置项进行设置，无需进入交互流程。--profile 省略时默认操作 default。
./ks3util config set key value [--profile <value>] [-c <value>] [-f]key 为配置项名，大小写不敏感，如 accessKeyID、accessKeySecret、endpoint 等。
配置项已存在时提示确认覆盖，加 -f 跳过确认。
指定的配置不存在时提示确认是否创建，加 -f 跳过确认直接创建。
参数 | 说明 |
|---|---|
key | 配置项名，大小写不敏感，如 |
value | 配置项的值。 |
--profile | 指定目标配置，未指定时默认 |
-c | 指定配置文件路径，未指定时默认 |
-f | 跳过覆盖确认与创建配置的确认，直接执行。 |
设置默认配置的 endpoint。
./ks3util config set endpoint ks3-cn-beijing.ksyuncs.com将 dev 配置的 endpoint 改为上海 region。
./ks3util config set endpoint ks3-cn-shanghai.ksyuncs.com --profile dev查询指定配置中某个配置项的值。--profile 省略时默认操作 default。
./ks3util config get key [--profile <value>] [-c <value>]参数 | 说明 |
|---|---|
key | 要查询的配置项名，大小写不敏感。 |
--profile | 指定目标配置，未指定时默认 |
-c | 指定配置文件路径，未指定时默认 |
查询默认配置的 endpoint。
./ks3util config get endpoint查询 dev 配置的 endpoint。
./ks3util config get endpoint --profile dev删除指定配置中的某个配置项。--profile 省略时默认操作 default。
./ks3util config delete key [--profile <value>] [-c <value>] [-f]删除前提示确认，加 -f 跳过确认。
参数 | 说明 |
|---|---|
key | 要删除的配置项名，大小写不敏感。 |
--profile | 指定目标配置，未指定时默认 |
-c | 指定配置文件路径，未指定时默认 |
-f | 跳过删除确认，直接删除。 |
删除默认配置的 endpoint。
./ks3util config delete endpoint删除 dev 配置的 endpoint。
./ks3util config delete endpoint --profile dev输出配置文件的内容，可选择查看整个文件或单个配置。
./ks3util config show [--profile <value>] [-c <value>]参数 | 说明 |
|---|---|
--profile | 指定要查看的配置，未指定时输出整个配置文件。 |
-c | 指定配置文件路径，未指定时默认 |
查看整个配置文件。
./ks3util config show查看单个配置。
./ks3util config show --profile dev旧版使用 [Credentials] 段的配置文件仍可正常使用，等效于 [profile default]；用 config 命令编辑时会自动转为 [profile default] 格式，原有配置值不丢失。
若旧配置文件中还包含按桶配置的 [Bucket-Endpoint] 或 [Bucket-Cname] 段，这些配置在运行时仍生效；config 命令编辑时只改 [Credentials] 段、不动这些桶级配置。
不支持在同一配置文件中混用新旧两种写法（如 [Credentials] 与 [profile] 并存）。遇到此类文件可加 -f 重新配置：原文件备份为 .bak 后重新生成。
纯净模式