快速上手

本篇目錄

視頻教學

觀看以下視頻，快速上手使用US3CLI

配置管理

此處主要介紹us3cli工具配置方式以及常見的使用場景，us3cli工具支持多種配置生成方式，對于不同配置項，支持配置項之間的切換、配置項刪除、更新、查看。對于單個配置項，支持配置內容加密（公私鑰）、HTTPS、代理。

配置項：一個配置項代表一個不同權限的配置文件，便于不同操作權限區分管理

配置方式根據是否保存配置文件做區分，分為常用配置和臨時配置，常用配置可進行更新、切換、查看等操作，臨時配置作為參數在其他命令運行時輸入，表示當前配置參數只在當前命令運行時生效。

命令格式：

us3cli config  [--ls][--su <配置名>][--rm <配置名>][--cat <配置名>][--encrypt][--ssl][--proxy [代理地址]]
               [--accesskey ][--secretkey ][--endpoint <訪問域名>]CopyErrorSuccess

常用配置創建方式分為兩種：交互式配置和一鍵配置，命令格式相同，使用方式不同

使用示例：

#./us3cli config
請輸入當前配置項名稱: config1
開始創建新配置項：[ config1 ]
是否啟用配置加密(y or n) ? n
請輸入API/Token公鑰[當前:]: xxxxxxxxxxxxxxxxxxxxxx
請輸入API/Token私鑰[當前:]: xxxxxxxxxxxxxxxxxxxxxx
地區列表：
No.     RegionName      Region      
0       北京        cn-bj       
1       上海二        cn-sh2      
2       廣州        cn-gd       
3       香港        hk          
4       洛杉磯        us-ca       
5       新加坡        sg          
6       雅加達        idn-jakarta 
7       臺北        tw-tp       
8       拉各斯        afr-nigeria 
9       圣保羅        bra-saopaulo
10      迪拜        uae-dubai   
11      法蘭克福        ge-fra      
12      胡志明市        vn-sng      
13      華盛頓        us-ws       
14      孟買        ind-mumbai  
15      首爾        kr-seoul    
請輸入region編號: 0
內外網列表：
No.     Network
0       外網   
1       內網   
請選擇或輸入內外網編號：0
您選擇的endpoint是：[cn-bj.ufileos.com],[當前:]，請輸入回車確認或自定義endponit：
當前最終配置：
ConfigName: config1
AccessKey: xxxxxxxxxxxxxxxxxxxxxx
SecretKey: xxxxxxxxxxxxxxxxxxxxxx
Endpoint: cn-bj.ufileos.com
請檢查后輸入回車確認：
是否啟用HTTPS (y or n) ? n
是否啟用代理(y or n):n
配置文件 [ config1 ] 已修改
是否使用該配置作為默認配置(當前默認配置為：< config >)(y or n)?CopyErrorSuccess

使用示例:

./us3cli config config1 --accesskey TOKEN_13be86********* --secretkey BAtrQO8LYdgve1HS_benbK-MXNTl3********** --endpoint cn-bj.ufileos.comCopyErrorSuccess

#切換默認配置
./us3cli config --su config1
#刪除指定配置（只支持指定配置項名稱刪除，不支持指定路徑）
./us3cli config --rm config1
#配置項內容查看，包含accesskey、secretkey、endpoint
./us3cli config --cat config1
#查看當前所有配置項列表，默認配置會標明 "(default)",Authority表示當前配置是Token密鑰類型還是API密鑰類型(只判斷類型，不進行權限驗證)
./us3cli config --lsCopyErrorSuccess

臨時配置可以通過配置名、配置文件路徑、配置項內容使用，具體示例如下:

#1.通過配置名指定臨時配置
./us3cli ls us3://bucket1 --config config2
#2.通過配置文件路徑指定臨時配置
./us3cli ls us3://bucket1 --config ~/go/src/userconfig.yaml
#3.通過配置項內容直接指定臨時配置
./us3cli ls us3://bucket1 --accesskey "xxxxxx" --secretkey "xxxxxx" --endpoint "xxxxxx"CopyErrorSuccess

注:當前版本支持自定義配置文件，但只支持與工具自動生成配置文件內容相同的配置文件

自定義配置文件內容如下,具體填寫說明見常用命令頁config命令介紹

accesskey: "user accesskey"
secretkey: "user secretkey"
endpoint: "ufile.cn-north-02.ucloud.cn"
encrypt: "false"
enablessl: "false"
proxy: "http://ip:port or https://ip:port"CopyErrorSuccess

創建存儲空間

命令格式:
us3cli mb us3://<bucketname>
使用示例：
# ./us3cli mb us3://bucketTest
請輸入要創建bucket的權限類型acl(private/public,默認為private):private  
地區列表：
No.     RegionName      Region      
0       北京        cn-bj       
1       上海二        cn-sh2      
2       廣州        cn-gd       
3       香港        hk          
4       洛杉磯        us-ca       
5       新加坡        sg          
6       雅加達        idn-jakarta 
7       臺北        tw-tp       
8       拉各斯        afr-nigeria 
9       圣保羅        bra-saopaulo
10      迪拜        uae-dubai   
11      法蘭克福        ge-fra      
12      胡志明市        vn-sng      
13      華盛頓        us-ws       
14      孟買        ind-mumbai  
15      首爾        kr-seoul     
請輸入要創建bucket地區編號或地區代碼(默認為北京:cn-bj):0
Region: cn-bj
當前賬號下項目信息如下：
No.     ProjectName     ProjectId 
1       Default         org-orcwsj
請輸入要創建bucket的項目編號:1
Number: 1
ProjectID: org-orcwsj
2020-11-24 17:52:56.973 INFO Make bucket [ bucketTest ] successCopyErrorSuccess

#命令格式：
us3cli mb us3://<bucketname> --projectid <projectid> --region <region> --acl <acl>
#使用示例：
./us3cli mb us3://buckettest --projectid org-test --region cn-bj --acl publicCopyErrorSuccess

上傳文件或文件夾

#命令格式：
#普通文件
us3cli cp <local filename> us3://<bucketname>/<us3key>
#流式文件
us3cli rcat us3://<bucketname>/<us3key>
#使用示例：
#普通上傳文件，不指定任何參數
./us3cli cp ./test.txt us3://buckettest/test.txt
#指定存儲類型為IA上傳 (不區分大小寫)
./us3cli cp ./test.txt us3://buckettest/test.txt --storageclass IA
#指定并發數，設置并發數為10(文件大于64MB時才會有效果,因為64MB以上大文件才會使用分片上傳)
./us3cli cp ./test.txt us3://buckettest/test.txt --parallel 10
#將本地文件test.txt cat到標準輸入，再上傳至us3存儲空間內
cat test.txt | ./us3cli rcat us3://buckettest/test.txt
#流式上傳并指定失敗重試次數為10，設置并發數為10
cat test.txt | ./us3cli rcat us3://buckettest/test.txt --retrycount 10 --parallel 10CopyErrorSuccess

#命令格式：
us3cli cp -r <localdir> us3://<bucketname>/<us3key>
#使用示例:
#普通上傳文件夾
./us3cli cp -r ./testdir us3://buckettest/us3dir
#上傳后綴名為“.txt"的文件
./us3cli cp -r ./testdir us3://buckettest/us3dir --include "*txt"
#上傳文件名不包含test的文件
./us3cli cp -r ./testdir us3://buckettest/us3dir --exclude "*test*"
#上傳文件夾并進行完整性校驗
./us3cli cp -r ./testdir us3://buckettest/us3dir --checkCopyErrorSuccess

增量上傳文件夾：對比本地文件夾和us3對應的文件夾，忽略已上傳的文件，將未上傳過的文件上傳到us3文件夾內

#命令格式:
us3cli sync <localdir> us3://<bucketname>/<us3key>
#使用示例:
#遍歷本地文件夾，以本地緩存為標準進行同步，如果文件修改時間晚于本地緩存保存的時間，或者未保存過，則上傳文件，否則跳過
./us3cli sync ./testdir us3://buckettest/us3dir
#遍歷本地文件夾，以本地緩存為標準進行同步，如果文件etag和本地緩存保存的etag不同，則上傳文件，否則跳過
./us3cli sync ./testdir us3://buckettest/us3dir --ruler etag
#遍歷本地文件夾，對比本地和us3所有文件，如果文件修改時間晚于us3文件的修改時間，則上傳文件，否則跳過
#如果存在文件在us3的目錄下存在，但在本地不存在，則刪除us3中的該文件（該刪除操作會默認詢問，目前不提供強制刪除功能）
./us3cli sync ./testdir us3://buckettest/us3dir --mode local
#遍歷本地文件夾，對比本地和us3所有文件，如果文件etag和us3同一文件的etag不同，則上傳文件，否則跳過
./us3cli sync ./testdir us3://buckettest/us3dir --mode local --ruler etag
#增量上傳并指定存儲類型為低頻類型
./us3cli sync ./testdir us3://buckettest/us3dir --storageclass ”IA“
#增量上傳并指定mimetype
./us3cli sync ./testdir us3://buckettest/us3dir --mimetype "mimetype1"CopyErrorSuccess

下載文件或文件夾

#命令格式：
#普通下載
us3cli cp  us3://<bucketname>/<us3key> <local filename>
#流式下載
us3cli cat us3://<bucketname>/<us3key>
#使用示例：
#普通下載單個文件
./us3cli cp us3://buckettest/test.txt ./test.txt
#下載文件，每個分片大小指定為8M(不區分大小寫，并且默認大小為4M，最小值為4M)
./us3cli cp us3://buckettest/test.txt ./test.txt --partsize 4M
#流式文件下載(文件會寫入到標準輸入)
./us3cli cat us3://buckettest/test.txt
#流式下載并指定并發數，重試次數為10
./us3cli cat us3://buckettest/test.txt --parallel 10 --retrycount 10CopyErrorSuccess

#命令格式：
us3cli cp -r  us3://<bucketname>/<us3key> <localdir>
#使用示例:
#普通下載文件夾
./us3cli cp -r  us3://buckettest/us3dir ./testdir
#下載文件夾并指定并發數為20
./us3cli cp -r us3://buckettest/us3dir ./testdir --parallel 20
#下載文件夾并限速為100MB/s
./us3cli cp -r us3://buckettest/us3dir ./testdir --speedlimit 100MBCopyErrorSuccess

拷貝文件或文件夾

#命令格式
us3cli cp us3://<bucketname>/<us3key>
#使用示例
#將文件從bucket1拷貝至bucket2中（兩個bucket必須在同一地域中，如需要不同地域的數據復制，則需要使用跨區域復制功能）
./us3cli cp us3://bucket1/test.txt us3://bucket2/test.txt
#將文件夾從bucket1拷貝到bucket2中
./us3cli cp -r us3://bucket1/test us3://bucket2/test
#將bucket1中test文件夾中以".txt"結尾的文件拷貝到bucket2的test文件夾中
./us3cli cp -r us3://bucket1/test us3://bucket2/test --include "*.txt"CopyErrorSuccess

刪除文件或文件夾

#命令格式：
us3cli rm  us3://<bucketname>/<us3key>
#使用示例：
#刪除文件
./us3cli rm us3://buckettest/test.txt
#強制刪除
./us3cli rm -f us3://buckettest/test.txtCopyErrorSuccess

#命令格式：
us3cli rm  -r us3://<bucketname>/<us3key>
#使用示例：
#刪除文件夾
./us3cli rm -r us3://buckettest/test
#強制刪除整個test文件夾
./us3cli rm -r -f us3://buckettest/test
#刪除test文件夾下不含有test的文件
./us3cli rm -r -f us3://buckettest/test --exclude "*test*"
#設置并發數為10，強制清空當前buckettest存儲空間
./us3cli rm -r -f us3://buckettest --parallel 10 
#刪除文件夾，限制請求數量為每秒10個
./us3cli rm -r -f us3://buckettest/test --qps 10CopyErrorSuccess

查詢文件基本信息

#命令格式
us3cli stat us3://<bucketname>/<us3key>
#使用示例
./us3cli stat us3://buckettest/test.txtCopyErrorSuccess

獲取文件列表

#命令格式
us3cli ls us3://<bucketname>[/us3key]
#使用示例
./us3cli ls us3://buckettest
#拉取buckettest中的文件，只顯示10個
./us3cli ls us3://buckettest --limit 10
#拉取buckettest中的文件，并以非目錄形式展示
#非目錄形式：目錄下所有的文件都顯示完整路徑，子目錄下的文件也會列出
./us3cli ls us3://buckettest --flat
#列取buckettest中的文件，并展示是否已取回，以及取回時間
#數據取回：指歸檔類型的數據短暫激活，可以下載
./us3cli ls us3://buckettest --restoreCopyErrorSuccess

文件基本信息修改

#命令格式
us3cli modify us3://<bucketname>/us3key
#使用示例
#修改文件mimetype為xxx/yyy
./us3cli modify us3://buckettest/test.txt --mimetype xxx/yyy
#為文件增加metadata  key為 "name"  value為 "us3cli"
./us3cli modify us3://buckettest/test.txt --metadata name=us3cli
#清空當前文件的metadata
./us3cli modify us3://buckettest/test.txt --metadata "" --replace
#修改文件的存儲類型為ARCHIVE(歸檔類型)
./us3cli modify us3://buckettest/test.txt --storageclass ARCHIVECopyErrorSuccess