當您需要將已上傳至OSS的檔案、圖片、視頻等資源下載到本地時,可以使用ossutil的cp命令。
注意事項
-
要下載檔案,您必須具有
oss:GetObject和oss:ListObjects許可權。具體操作,請參見為RAM使用者授予自訂的權限原則。 -
使用
-u, --update選項時,系統會對每個待檢查檔案(無論目標檔案是否存在)至少發起一次 HEAD 請求以進行比對。在資料變更較少的情境下,將產生大量低效請求,可能影響效能並帶來額外的請求費用。建議結合實際業務情況評估後再謹慎使用,避免不必要的資源消耗。
命令格式
ossutil cp oss://bucket[/prefix] local-path [flags]
|
參數 |
類型 |
說明 |
|
local-path |
string |
支援相對路徑、絕對路徑和 |
|
prefix |
string |
對象首碼。當prefix以"/"結尾時,只支援大量操作。當prefix不以"/"結尾時,根據命令列選項判斷為單對象下載還是批量下載。 |
|
--acl |
string |
對象的存取權限。取值:
|
|
--bandwidth-limit |
SizeSuffix |
用於限制網路頻寬,控制資料轉送的速率。最小值為1024 B/s。單位預設為B/s。 配置此參數時,可以根據需要為頻寬值指定單位,可選單位包括B(位元組)、K(KB)、M(MB)和G(吉位元組)。例如 50 M表示頻寬節流設定為50 MB/s。 |
|
--bigfile-threshold |
SizeSuffix |
開啟大檔案分區上傳、下載或拷貝的閾值(預設值104857600)。 |
|
--cache-control |
string |
指定該對象被下載時網頁的緩衝行為。 |
|
--checkers |
int |
並行啟動並執行檢查器數量(預設值為16)。 |
|
--checkpoint-dir |
string |
斷點續傳資訊的指定目錄(預設值 |
|
--content-disposition |
string |
指定對象的展示形式。 |
|
--content-encoding |
string |
聲明對象的編碼方式。 |
|
--content-type |
string |
對象的內容類型。 |
|
--copy-props |
string |
用於控制中繼資料和標籤的複製規則。取值如下:
|
|
-d, --dirs |
string |
下載目前的目錄下的檔案和子目錄,而非遞迴顯示所有子目錄下的所有檔案。 |
|
--encoding-type |
string |
輸入的對象名或檔案名稱的編碼方式。取值:url。 |
|
--end-with |
string |
按字母排序,返回設定值之前的對象,包含設定值。 |
|
--exclude |
stringArray |
路徑或檔案名稱的排除規則。 |
|
--exclude-from |
stringArray |
從規則檔案裡讀取排除規則。 |
|
--expires |
string |
指定緩衝內容的絕對到期時間。 |
|
--files-from |
stringArray |
從檔案中讀取源檔案名稱列表,忽略空行或注釋行。僅適用於過濾情境。 |
|
--files-from-raw |
stringArray |
從檔案中讀取源檔案名稱列表。僅適用於過濾情境。 |
|
--filter |
stringArray |
路徑或檔案名稱過濾規則。 |
|
--filter-from |
stringArray |
從規則檔案讀取過濾規則。 |
|
-f, --force |
/ |
強制操作,不進行詢問提示。 |
|
--include |
stringArray |
路徑或檔案名稱的包含規則。 |
|
--include-from |
stringArray |
從規則檔案裡讀取包含規則。 |
|
-j, --job |
int |
並發任務數,預設值為 3。 說明
僅在同時指定 |
|
--list-objects |
/ |
使用ListObjects介面列舉對象。 |
|
--max-size |
SizeSuffix |
限制傳輸的最大檔案大小,預設是位元組,或單位尾碼形式B|K|M|G|T|P,1K(KiB)=1024B。 |
|
--metadata |
strings |
指定對象的使用者中繼資料,使用key=value格式。 |
|
--metadata-directive |
string |
指定如何設定目標對象的中繼資料。取值:
|
|
--metadata-exclude |
stringArray |
對象中繼資料的排除規則。 |
|
--metadata-filter |
stringArray |
對象中繼資料過濾規則。 |
|
--metadata-filter-from |
stringArray |
從規則檔案讀取對象中繼資料過濾規則。 |
|
--metadata-include |
stringArray |
對象中繼資料的包含規則。 |
|
--min-age |
Duration |
僅下載修改時間在指定時間間隔前的檔案,預設單位是秒,可以使用單位尾碼形式。例如 1h,表示1小時。 說明
|
|
--max-age |
Duration |
僅下載修改時間在指定時間間隔內的檔案,預設單位是秒,可以使用單位尾碼形式。例如 1h,表示1小時。 說明
|
|
--min-mtime |
Time |
僅下載修改時間在指定時間之後的檔案,時間格式:UTC時間。例如2006-01-02T15:04:05。 說明
|
|
--max-mtime |
Time |
僅下載修改時間在指定時間之前的檔案,時間格式:UTC時間,例如 2006-01-02T15:04:05。 |
|
--min-size |
SizeSuffix |
限制傳輸的最小檔案大小,預設是位元組,或單位尾碼形式B|K|M|G|T|P,1K(KiB)=1024B。 |
|
--no-progress |
/ |
不顯示進度條。 |
|
--page-size |
int |
批量下載時分頁列舉對象的最大值(預設值1000),取值範圍1~1000。 |
|
--parallel |
int |
單檔案內部操作的並發任務數。 |
|
--part-size |
SizeSuffix |
分區大小,預設情況下根據檔案大小自行計算合適的分區大小值。取值範圍100KiB~5GiB。 |
|
-r, --recursive |
/ |
遞迴進行操作。當指定該選項時,命令會對儲存空間下所有合格對象進行操作,否則只對路徑指定的對象進行操作。 |
|
--request-payer |
string |
請求的支付方式,如果為要求者付費模式,請設定該值。取值:requester。 |
|
--size-only |
/ |
僅下載檔案大小不一致的源檔案。 |
|
--start-after |
string |
按字母排序,返回設定值之後的對象,不包含設定值。 |
|
--storage-class |
string |
對象的儲存類型, 取值:
|
|
--tagging |
strings |
指定對象的標籤,使用key=value格式。 |
|
--tagging-directive |
string |
指定如何設定目標對象的標籤。取值:
|
|
-u, --update |
/ |
跳過目標端已存在且修改時間比源檔案更新的檔案。 說明
如果目標端已存在的檔案的修改時間比源檔案的修改時間早,則會更新該檔案。 |
|
--ignore-existing |
/ |
跳過已存在的目標檔案。 |
|
--version-id |
string |
指定對象的版本 ID(VersionId)。 |
|
--write-buffer-size |
SizeSuffix |
寫入時使用的記憶體緩衝區大小。會自動按 4KB 對齊;支援尾碼 B / K / M(預設 128KiB)。取值範圍:0 ~ 32MiB。 |
從 ossutil 2.3.0 起,--job、--parallel、--bigfile-threshold、--part-size、--write-buffer-size 選項支援通過設定檔設定。在設定檔對應 profile 段下以 key=value 格式追加(例如 job=10),或通過 ossutil config set 寫入。命令列選項的優先順序高於設定檔。
關於支援的全域命令列選項,請參見全域命令列選項。
目標檔案命名規則如下:
-
單檔案下載時,如果目的為目錄,則在該目錄下建立源檔案相對路徑的檔案。
-
單檔案下載時,如果目的為檔案或者不存在, 則與目的檔案名稱保持一致。
-
批量下載時,則在目的根目錄下,以源檔案相對路徑,逐級建立子目錄,直到建立檔案。
源檔案相對路徑規則為:去掉prefix包括最後一個 '/' 之前的字元後的名字,
cp oss://bucket/root/dir/ ... 時,對象root/dir/subdir/test.txt 的相對路徑為subdir/test.txt。
使用樣本
下載單個檔案
下載檔案時如果未指定檔案名稱,則預設使用原檔案名稱儲存在本地。如果指定檔案名稱,則按照指定檔案名稱儲存在本地。
-
沿用原檔案名稱儲存檔案
ossutil cp oss://examplebucket/examplefile.txt D:/localpath -
按指定檔案名稱儲存檔案
ossutil cp oss://examplebucket/examplefile.txt D:/localpath/example.txt
下載多個檔案
-
下載某一類檔案
如果您希望同時下載多個檔案名稱規律的檔案,例如這些檔案均包含相同首碼或者尾碼,此時您可以結合--include和--exclude選項在下載時選擇合格檔案。
下載所有檔案格式不為JPG的檔案:
ossutil cp oss://examplebucket/destfolder/ D:/localpath/ --exclude "*.jpg" -r -
下載檔案夾
ossutil cp -r oss://examplebucket/destfolder/ D:/localpath/ -
下載Bucket根目錄下的所有檔案
ossutil cp -r oss://examplebucket D:/localpath/
下載時限速
將examplefile.txt檔案下載到目前的目錄,並將下載速度限制為20 MB/s。
ossutil cp oss://examplebucket/examplefile.txt . --bandwidth-limit 20971520