ossutil的使用
設置ossutil的語言
在使用ossutil的命令時,可以使用-L選項設置語言,可選範圍爲CH/EN,即:中文或英文。大小寫不敏感。默認語言爲CH(中文),如果設置成CH(中文),需要確保您的系統爲utf-8編碼,否則可能會顯示亂碼。
如:
./ossutil help ls
顯示ls默認語言的幫助
./ossutil help ls -L ch
顯示ls的中文幫助
./ossutil help ls -L en
顯示ls的英文幫助
./ossutil config -L ch
運行ossutil config的交互式配置命令,其中的提示語言爲中文。
./ossutil config -L en
運行ossutil config的交互式配置命令,其中的提示語言爲英文。
注意:ossutil輸出的錯誤默認都爲英文,不會受上述選項影響。
獲取命令列表
./ossutil
或 ./ossutil help
$./ossutil用法: ossutil [command] [args...] [options...]請使用ossutil help command來顯示command命令的幫助Commands: mb cloud_url [options] 創建Bucket ls [cloud_url] [options] 列舉Buckets或者Objects rm cloud_url [options] 刪除Bucket或Objects stat cloud_url [options] 顯示bucket或者object的描述信息 set-acl cloud_url [acl] [options] 設置bucket或者objects的acl set-meta cloud_url [meta] [options] 設置已上傳的objects的元信息 cp src_url dest_url [options] 上傳,下載或拷貝Objects restore cloud_url [options] 恢復冷凍狀態的Objects爲可讀狀態 create-symlink cloud_url target_url [options] 創建符號鏈接 read-symlink cloud_url [options] 讀取符號鏈接文件的描述信息Additional Commands: help [command] 獲取命令的幫助文檔 config [options] 創建配置文件用以存儲配置項 hash file_url [options] 計算本地文件的crc64或md5 update [options] 更新ossutil
$./ossutil -L enUsage: ossutil [command] [args...] [options...]Please use 'ossutil help command' to show help of commandCommands: mb cloud_url [options] Make Bucket ls [cloud_url] [options] List Buckets or Objects rm cloud_url [options] Remove Bucket or Objects stat cloud_url [options] Display meta information of bucket or objects set-acl cloud_url [acl] [options] Set acl on bucket or objects set-meta cloud_url [meta] [options] set metadata on already uploaded objects cp src_url dest_url [options] Upload, Download or Copy Objects restore cloud_url [options] Restore Frozen State Object to Read Ready Status create-symlink cloud_url target_url [options] Create symlink of object read-symlink cloud_url [options] Display meta information of symlink objectAdditional Commands: help [command] Get help about commands config [options] Create configuration file to store credentials hash file_url [options] Get crc64 or md5 of local file update [options] Update ossutil
查看某命令的幫助文檔
./ossutil help cmd
強烈建議在使用某命令前先使用help來查閱幫助文檔。
./ossutil help config -L chSYNOPSIS 創建配置文件用以存儲配置項SYNTAX ossutil config [-e endpoint] [-i id] [-k key] [-t token] [-L language] [--output-dir outdir] [-c file]DETAIL DESCRIPTION 該命令創建配置文件,將用戶設置的配置項信息存儲進該配置文件,配置項用 以訪問OSS時提供訪問信息(某命令是否需要配置項,參見其是否支持 --config-file選項,具體可見該命令的幫助)。 配置文件路徑可由用戶指定,默認爲/home/admin/.ossutilconfig。如果配置 文件存在,假設其爲:a,ossutil會將文件a另存爲:a.bak,然後重新創建文件a 並寫入配置,此時,如果a.bak存在,其會被文件a覆蓋。 注意: (1)如果指定的配置文件路徑非默認路徑,在使用命令時請將--config-file選 項設置爲你配置時指定的配置文件路徑(如果不指定--config-file選項,則運 行命令時默認會讀取/home/admin/.ossutilconfig)。 (2)某些配置可在使用命令時通過選項進行設置,如--endpoint,--access-key-id, 等選項(具體請見每個命令的幫助),如果使用命令時指定了這些選項,並且同 時配置文件中也配置了這些信息,則優先級爲:選項 > 配置文件。 (3)如果使用命令時指定了--endpoint、--access-key-id、--access-key-secret 或--sts-token選項,則ossutil不強求配置文件一定要存在。用法: 該命令有兩種用法,交互式1)和非交互式2),推薦用法爲交互式,因爲交互 式用法擁有更好的安全性。 1) ossutil config [-c file] 該用法提供一種交互式的方法來配置信息,ossutil交互式地詢問用戶如下 信息: (1) config file 配置文件路徑,如果用戶鍵入回車,ossutil會使用默認的配置文件: /home/admin/.ossutilconfig。 如果用戶自己指定了配置文件,在使用命令時需要將--config-file選項 設置爲用戶設置的配置文件路徑。哪些命令支持--config-file選項可由查看 每個命令的幫助。 (2) language 當首次配置(配置文件不存在)時,ossutil會向用戶詢問語言設置,可 選值爲中文或者英文(CH/EN),如果鍵入回車,ossutil將根據用戶輸入的 --language選項配置,如果此時用戶也未輸入--language選項,將配置成默認 語言中文。 如果配置文件已存在,ossutil會綜合用戶輸入的language選項和配置文件 中的語言信息,配置該項,而不會詢問。 ossutil在運行時會從配置文件中讀取該language選項,如果該選項不存在 或者非法,將採用默認語言:CH。 注意:該配置項在此次config成功結束後纔會生效,在執行config命令過 程中語言顯示不會受用戶的選擇影響。 (3) endpoint, accessKeyID, accessKeySecret 回車代表着跳過相應配置項的設置。注意:endpoint應該爲一個二級域 名(SLD),例如:oss.aliyuncs.com。 以上選項一般爲必選項。 (4) stsToken 如果用戶需要使用臨時token來訪問oss,用戶需要填入該項,否則請輸入 回車跳過該項配置。 (5) outputDir 該選項配置輸出文件所在目錄的路徑。交互式模式時不提供該選項的配置, 但配置文件中該項配置起效。 outputDir的默認目錄爲:當前目錄下的:ossutil_output,ossutil會在 運行過程中將輸出文件都生成到該文件夾下。輸出文件目前包含:在cp命令中 批量操作出錯時,記錄每個文件操作的錯誤信息的report文件。 關於outputDir和report文件的更多信息請參見cp命令的幫助。 注意:outputDir如果不存在,ossutil在產生輸出文件時會自動創建該目錄, 如果outputDir存在且並非目錄,將會報錯。 下述交互式Bucket-Endpoint和Bucket-Cname配置被取消,但配置文件中該兩項 配置仍然起效。 (6) Bucket-Endpoint Bucket-Endpoint對每個指定的bucket單獨配置endpoint,此配置會優先於 配置文件中關於默認endpoint的配置。 在該版本中,ossutil取消了交互式配置中,關於Bucket-Endpoint配對的配 置,但配置文件中該項配置仍然起效,所以如果用戶想對每個bucket單獨指定 endpoint,仍然可以在配置文件中進行配置。注意:此處的endpoint應該爲一個 二級域名(SLD),例如:oss.aliyuncs.com。 如果配置了Bucket-Endpoint選項,當對某bucket進行操作時,ossutil會在 該選項中尋找該bucket對應的endpoint,如果找到,該endpoint會覆蓋基本配置 中endpoint。但是運行命令時如果指定了--endpoint選項,--endpoint選項爲最 高優先級。 (7) Bucket-Cname Bucket-Cname爲每個指定的bucket單獨配置CNAME域名(CDN加速域名),此 配置會優先於配置文件中Bucket-Endpoint及endpoint的配置。 在該版本中,ossutil取消了交互式配置中,關於Bucket-Cname配對的配置, 但配置文件中該項配置仍然起效,所以如果用戶想對每個bucket單獨指定CNAME 域名,仍然可以在配置文件中進行配置。 如果配置了Bucket-Cname選項,當對某bucket進行操作時,ossutil會在該 選項中尋找該bucket對應的CNAME域名,如果找到,則找到的CNAME域名會覆蓋 Bucket-Endpoint選項和基本配置中的endpoint。運行命令時如果指定了--endpoint 選項,--endpoint選項爲最高優先級。 優先級:--endpoint > Bucket-Cname > Bucket-Endpoint > endpoint > 默認endpoint 2) ossutil config options 如果用戶使用命令時輸入了除--language和--config-file之外的任何選項,則 該命令進入非交互式模式。所有的配置項應當使用選項指定。配置文件格式: [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 ...SAMPLE ossutil config ossutil config -e oss-cn-hangzhou.aliyuncs.com -c ~/.myconfigOPTIONS -c, --config-file ossutil工具的配置文件路徑,ossutil啓動時從配置文件讀取配置,在config命令中,ossutil將配置寫入該文件。 -e, --endpoint ossutil工具的基本endpoint配置(該選項值會覆蓋配置文件中的相應設置),注意其必須爲一個二級域名。 -i, --access-key-id 訪問oss使用的AccessKeyID(該選項值會覆蓋配置文件中的相應設置)。 -k, --access-key-secret 訪問oss使用的AccessKeySecret(該選項值會覆蓋配置文件中的相應設置)。 -t, --sts-token 訪問oss使用的STSToken(該選項值會覆蓋配置文件中的相應設置),非必須設置項。 --output-dir=ossutil_output 指定輸出文件所在的目錄,輸出文件目前包含:cp命令批量拷貝文件出錯時所產生的report文件(關於report文件更多信息,請參考cp命令幫助)。默認值爲:當前目錄下的ossutil_output目錄。 -L CH, --language=CH 設置ossutil工具的語言,默認值:CH,取值範圍:CH/EN,若設置成"CH",請確保您的系統編碼爲UTF-8。
配置ossutil
在使用訪問oss的命令時,需要先配置訪問AK,關於AK的更多信息見:RAM和STS介紹
配置ossutil由兩種方式:交互式和非交互式。
關於配置命令的更多幫助,請使用ossutil help config
查看。
非交互式配置ossutil
./ossutil config
$./ossutil config -L ch該命令創建將一個配置文件,在其中存儲配置信息。請輸入配置文件路徑(默認爲:/home/admin/.ossutilconfig,回車將使用默認路徑。如果用戶設置爲其它路徑,在使用命令時需要將--config-file選項設置爲該路徑):
非交互式配置ossutil
./ossutil config -e oss.aliyuncs.com -i your_id -k your_key