config命令用于创建配置文件来存储OSS访问信息。您可以在使用其他命令时添加-c选项,ossutil将使用指定的配置访问目标OSS。

说明 本文命令均以Linux系统为例,实际使用时,请将命令名称改为您实际可执行程序文件的名称。例如Windows 32位系统的帮助命令为ossutil32.exe help

命令格式

./ossutil config [-e endpoint] [-i id] [-k key] [-t token] [-L language] [--output-dir outdir] [-c file]
说明 该命令有两种用法,交互式和非交互式。推荐您使用安全性更高的交互式用法。

使用示例

  • 交互式配置
    ./ossutil config
    请输入配置文件名,文件名可以带路径(默认为:/home/user/.ossutilconfig,回车将使用默认路径。
    如果用户设置为其它路径,在使用命令时需要将--config-file选项设置为该路径): 
    未输入配置文件路径,将使用默认配置文件:/home/user/.ossutilconfig。 
    对于下述配置,回车将跳过相关配置项的设置,配置项的具体含义,请使用"help config"命令查看。 
    请输入endpoint:https://oss-cn-shenzhen.aliyuncs.com 
    请输入accessKeyID:yourAccessKeyID 
    请输入accessKeySecret:yourAccessKeySecret
    请输入stsToken: 
    • endpoint:填写Bucket所在地域的域名信息,详情请参见访问域名和数据中心。您也可以增加http://https://指定ossutil访问OSS使用的协议,默认使用HTTP协议。
    • accessKeyID:查看方式请参见创建AccessKey
    • accessKeySecret:查看方式请参见创建AccessKey
    • stsToken:仅在使用STS临时授权方式访问OSS需要配置该项,否则置空即可。stsToken生成方式参见临时访问凭证
  • 非交互式配置
    ./ossutil config -e oss-cn-beijing.aliyuncs.com -i LTAIbZcdVCmQ**** -k D26oqKBudxDRBg8Wuh2EWDBrM0****  -L CH -c /myconfig

    如果您使用命令时输入了除--language--config-file之外的任意选项,则进入非交互式模式,所有的配置项需使用选项指定。

配置文件格式

对于已经生成的配置文件,您也可以通过直接编辑配置文件来修改OSS访问信息。ossutil工具的配置文件格式如下:
[Credentials]
        language = CH
        endpoint = oss.aliyuncs.com
        accessKeyID = your_key_id
        accessKeySecret = your_key_secret
        stsToken = your_sts_token
        outputDir = your_output_dir
[Bucket-Endpoint]
        bucket1 = endpoint1
        bucket2 = endpoint2
        ...
[Bucket-Cname]
        bucket1 = cname1
        bucket2 = cname2
        ...
[AkService]
        ecsAk=http://100.100.100.200/latest/meta-data/Ram/security-credentials/EcsRamRoleTesting
  • Bucket-Endpoint:对每个指定的Bucket单独配置Endpoint,当对某Bucket进行操作时,ossutil会在该选项中寻找该Bucket对应的Endpoint,如果找到,该Endpoint会覆盖Credentials选项中的endpoint。
  • Bucket-Cname:Bucket-Cname为每个指定的Bucket单独配置CNAME域名,此配置会优先于配置文件中Bucket-Endpoint及Credentials选项中endpoint的配置。关于CNAME域名的更多信息请参见绑定自定义域名
  • AkService:此项默认不增加,如果您希望使用ECS实例绑定的RAM角色操作OSS的话,需配置此项。配置时仅需将EcsRamRoleTesting改为ECS实例绑定的角色名称即可。配置此项后,accessKeyID、accessKeySecret、stsToken可不配置;如果配置了accessKeyID,那么AkService的配置将不会生效,而是以配置的accessKeyID、accessKeySecret、stsToken进行身份校验。ECS实例绑定RAM角色请参见授予实例RAM角色
注意
  • 在新版本中,ossutil取消了交互式配置中关于Bucket-Endpoint和Bucket-Cname项的配置,但配置文件中该项配置仍然生效,您可以在配置文件中对每个Bucket单独指定Endpoint或CNAME。
  • ossutil工具可以在多个地方指定Endpoint,生效优先级为:--endpoint(命令选项) > Bucket-Cname > Bucket-Endpoint > endpoint(Credentials项) 。

常用选项

您可以在使用config命令时,指定如下选项来生成指定的配置项:
选项名称 描述
-e,--endpoint 设置配置文件中Credentials选项的endpoint项。
-i,--access-key-id 设置配置文件中Credentials选项的accessKeyID项。
-k,--access-key-secret 设置配置文件中Credentials选项的accessKeySecret项。
-t,--sts-token 设置配置文件中Credentials选项的stsToken项,非必填项。
--output-dir 指定输出文件所在的目录。输出文件目前包含cp命令批量拷贝文件出错时所产生的report文件。

默认值为:当前目录下的ossutil_output目录。

-L,--language 设置ossutil工具的语言。
可选值为:
  • CH:简体中文。若设置成CH,请确保您的系统编码为UTF-8。
  • EN:英文。

默认值:CH

--loglevel 设置日志级别,默认为空,表示不输出日志文件。可选值为:
  • info:输出提示信息日志。
  • debug:输出详细信息日志(包括http请求和响应信息)。
说明 更多通用选项请参见查看选项