全部產品
Search

搜尋本產品

    Object Storage Service：config（建立設定檔）

    文件中心

    Object Storage Service：config（建立設定檔）

    更新時間：Jul 31, 2024

    您可以通過config命令建立設定檔，用於儲存OSS訪問資訊。您可以在使用其他命令時添加-c選項，ossutil將通過指定的配置來訪問OSS。

    重要

    從ossutil 1.6.16版本開始，命令列中Binary名稱支援直接使用ossutil，您無需根據系統重新整理Binary名稱。如果您的ossutil版本低於1.6.16，則需要根據系統重新整理Binary名稱。更多資訊，請參見命令列工具ossutil命令參考。

    命令格式

    該命令有互動式和非互動式兩種用法。互動式用法允許您在使用命令前，通過設定檔完成相關配置項。命令使用過程中，ossutil將直接讀取設定檔中的配置。而非互動式用法則需要您在使用命令時，通過選項來指定需要的配置項。相比非互動式用法，互動式用法具有更高的安全性。

    該命令的非互動式用法的命令格式如下：

    ossutil config 
[-e，--endpoint <value>] 
[-i，--access-key-id <value>] 
[-k，--access-key-secret <value>] 
[-t，--sts-token <value>]
[--ram-role-arn <value>]
[-L language <value>] 
[--output-dir <value>] 
[-c，--config-file <value>]

    各選項說明如下：

    選項

    說明

    -e，--endpoint

    填寫Bucket所在地區的網域名稱資訊，詳情請參見訪問網域名稱和資料中心。您也可以增加http://或https://指定ossutil訪問OSS使用的協議，預設使用HTTP協議。

    -i，--access-key-id

    指定設定檔中Credentials選項下的AccessKey ID。有關如何查看AccessKey ID資訊的具體步驟，請參見擷取AccessKey。

    -k，--access-key-secret

    指定設定檔中Credentials選項下的AccessKey Secret。有關如何查看AccessKey Secret資訊的具體步驟，請參見擷取AccessKey。

    -t，--sts-token

    訪問OSS使用的STSToken，僅在使用STS臨時授權方式訪問OSS時需要配置此項。關於如何產生STSToken的具體步驟，請參見使用STS臨時訪問憑證訪問OSS。

    --ram-role-arn

    RamRoleArn鑒權模式下的RAM角色ARN。僅在使用RAM使用者的AssumeRole的方式訪問時需要配置此項。

    -L language

    設定ossutil工具的語言。取值如下：

    • CH（預設值）：中文。設定為CH時，請確保您的系統編碼方式為UTF-8。

    • EN：英文。

    --output-dir

    指定輸出檔案所在的目錄，輸出檔案目前包含cp命令批量拷貝檔案出錯時所產生的report檔案。

    預設值：目前的目錄下的ossutil_output目錄。

    -c，--config-file

    ossutil工具的設定檔路徑，ossutil啟動時將從設定檔讀取配置。

    使用樣本

    • 互動式配置 

      ossutil config
請輸入設定檔名，檔案名稱可以帶路徑（預設為：/home/user/.ossutilconfig，斷行符號將使用預設路徑。
如果使用者佈建為其它路徑，在使用命令時需要將--config-file選項設定為該路徑）： 
未輸入設定檔路徑，將使用預設設定檔：/home/user/.ossutilconfig。 
對於下述配置，斷行符號將跳過相關配置項的設定，配置項的具體含義，請使用"help config"命令查看。 
請輸入endpoint：https://oss-cn-shenzhen.aliyuncs.com 
請輸入accessKeyID：yourAccessKeyID 
請輸入accessKeySecret：yourAccessKeySecret
請輸入stsToken：yourStsToken

    • 非互動式配置 

      ossutil config -e oss-cn-beijing.aliyuncs.com -i LTAIbZcdVCmQ**** -k D26oqKBudxDRBg8Wuh2EWDBrM0****  -L CH -c /myconfig

      如果您使用命令時輸入了除-L language和-c，--config-file以外的任意選項，則進入非互動式模式，所有的配置項需使用選項來指定。

    編輯設定檔

    重要

    • 在新版本中，ossutil取消了互動式配置中關於Bucket-Endpoint和Bucket-Cname項的配置。您可以在設定檔中對每個Bucket單獨指定Endpoint或CNAME。

    • ossutil支援通過不同方式指定Endpoint，Endpoint生效優先順序為--endpoint（命令選項） > Bucket-Cname > Bucket-Endpoint > endpoint（Credentials項） 。

    對於已經產生的設定檔，您也可以通過直接編輯設定檔來修改OSS訪問資訊。ossutil工具的設定檔格式如下： 

    [Credentials]
        language = CH
        endpoint = oss.aliyuncs.com
        accessKeyID = your_accesskey_id
        accessKeySecret = your_accesskey_secret
        stsToken = your_sts_token
        outputDir = your_output_dir
        ramRoleArn = your_ram_role_arn
[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
[Default]
        userAgent = user_agent
        loglevel = log_level
        proxyHost = proxy_host
        proxyUser = proxy_user
        proxyPwd = proxy_pwd
        readTimeOut = read_time_out
        connectTimeOut = connect_time_out
        retryTimes = retry_times

    • Bucket-Endpoint：為每個指定的Bucket單獨配置Endpoint。

    • Bucket-Cname：為每個指定的Bucket單獨配置CNAME網域名稱。關於CNAME網域名稱的更多資訊，請參見綁定自訂網域名。

    • AkService：當您希望使用ECS執行個體綁定的RAM角色操作OSS時，需配置此項。配置時僅需將EcsRamRoleTesting改為ECS執行個體綁定的角色名稱即可。配置此項後，AccessKey ID、AccessKey Secret、STSToken可不配置。如果配置了AccessKey ID，則AkService的配置將不會生效，而是以配置的AccessKey ID、AccessKey Secret、STSToken進行身份校正。ECS執行個體綁定RAM角色請參見通過ECS執行個體RAM角色授權ECS訪問其他雲端服務。

    • Default：當您需要修改通用參數的預設值時，可以配置此項。關於選項的更多說明，請參見查看選項。

      說明

      僅1.7.15及以上版本支援配置Default。