摘要：介紹因產品升級，將暫停維護。只能依賴于工具進行相關操作。下載存檔下載一個激活的存檔，必須指定。請注意，在當前版本參數不能省略，這是一個，我們將在稍后的版本修正它刪除存檔刪除一個存檔必須指定。

介紹(Introduction)

因產品升級，UArchive 將暫停維護。
請使用 US3 對象存儲歸檔類型，以獲取更優惠更可靠的歸檔存儲服務：US3 產品價格

UArchive是UCLOUD公司的歸檔存儲產品，你可以把本地的任意文件，壓縮包，或者文件夾上傳到Uarchive。
稍后在您需要時可以從Uarchive下載指定的文件。Uarchive和Ufile不同，它無法在UCLOUD官方控制臺上進行文件的上傳，下載動作。
只能依賴于uarchivemgr工具進行相關操作。你可以從下面這個地址獲取這個工具。

Linux 64位操作系統請下載

http://tools.ufile.ucloud.cn/uarchivemgr-linux64.tar.gz

Windows 32位操作系統請下載

http://tools.ufile.ucloud.cn/uarchivemgr-win32.tar.gz

Windows 64位操作系統請下載

http://tools.ufile.ucloud.cn/uarchivemgr-win64.tar.gz

MacOS 操作系統請下載

http://tools.ufile.ucloud.cn/uarchivemgr-mac.tar

# 名詞定義(Definition) 這里我們將介紹一些名詞，稍后在使用uarchivemgr工具的過程中，您將會看到他們。
工具中將只顯示英文，為了方便您的理解，我們特別將關鍵詞都以中文對照以及解釋的方式列在下面這里，方便參考。

# 工具配置(Configuration)
下載工具并解壓縮之后，您需要編輯config.cfg文件并指定正確的公鑰(PublicKey)和私鑰(PrivateKey)。如果您不知道什么是公鑰和私鑰，請聯系技術支持。

# 工作流程(Workflow)

開始(Start) ---> 創建倉庫(Create Vault)
                        |--> 上傳文件或目錄存檔(Put File or Dir to Uarchive)
                        |
                        |--> 獲取存檔列表(Get Archive List)
                        |
                        |--> 激活存檔(Activate Archive)
                                      |---> 下載存檔(Download Archive)
                        |--> 刪除存檔(Delete Archive)

結束(End) ---> 刪除倉庫(Delete Vault)

# 選項和示例(Options and Examples)
基本的工具選項將被列在下面，當您理解了這些選項之后，可以通過幫助(Help)來獲取高級選項信息。

# 獲取工具版本(Version)

./uarchivemgr-linux64 version

# 倉庫管理(Vault Management)

# 創建一個倉庫(Vault) 必須要指定--vault 其后是該倉庫的名稱 這個名稱在后面操作會被作為參數傳遞給這個工具
./uarchivemgr-linux64 CreateVault --vault test-u2

# 刪除一個倉庫(Vault) 必須要指定--vault 當您不再需要這個倉庫時 可以使用下面這行命令來執行刪除 現在先跳過這個命令
# ./uarchivemgr-linux64 DeleteVault --vault test-u2

# 獲取倉庫(Vault)信息 可以選擇指定--vault或不指定，如果指定，則顯示某一個倉庫(Vault)的信息，如果不指定，則顯示全部。只會顯示用戶自己的倉庫(Vault)信息。備注: 當前版本 指定倉庫(--vault)選項無法正常工作
./uarchivemgr-linux64 DescribeVault [--vault test-u2]

# 上傳存檔(PutArchive)

# 上傳一個文件(File)，必須要指定--vault --file --archive三個參數，其中--file后面是一個合法的本地文件路徑，--archive后面是您指定的存檔名稱，這個參數在當前版本的工具中不可以省略，您可以將它指定為文件的名字
./uarchivemgr-linux64 PutArchive --vault test-u2 --file /root/config.cfg --archive config.cfg

# 上傳一個文件夾(Dir) 必須指定--vault --dir兩個參數 多余的參數將會被忽略. 其中--dir后面是一個合法的本地文件夾的地址 該文件夾下所有的文件(File)會被上傳到歸檔存儲 請參考--trimpath的說明來獲取更多信息
./uarchivemgr-linux64 PutArchive --vault test-u2 --dir /home/marvin/uarchive-test

# 獲取存檔列表(GetArchiveList)

使用這個功能，您可以獲取一個倉庫的存檔列表。也就是您上傳的文件的列表，如果一個文件的多個版本在上傳的時候指定了不同的存檔名稱，那么您將看到它們。
# test-u2是一個合法且存在的倉庫(Vault)名稱，您需要將它替換為您自己的倉庫名稱，在后續的所有例子中，都會使用"test-u2"作為測試倉庫。必須指定--vault選項，該選項后面是倉庫的名稱，下面的例子里面也會使用這個參數將不再多帶帶解釋
./uarchivemgr-linux64 GetArchiveList --vault test-u2
# 這個命令會輸出下面這樣的一個輸出， 其中Key的值是后面激活存檔(ActivateArchive)功能需要的參數
{
        VaultName:    test-u2
        Key:          config.cfg
        Hash:         AQAAALYX2XqoLlhkvFiBes1z04GAXbT0
        MimeType:     application/octet-stream
        Size:         278
        Created:      1556435482
        Modified:     1556435482
}

# 激活存檔(ActivateArchive)

# 激活一個存檔(Archive)，必須指定--vault和--archive，其中--archive后面指定存檔(Archive)的Key 這個Key可以在GetArchiveList的返回列表中看到。
./uarchivemgr-linux64 ActivateArchive --vault test-u2 --archive config.cfg

# 下載存檔(DownloadArchive)

# 下載一個激活的存檔(Archive)，必須指定--vault --archive --saveas。其中--archive后面指定一個已經被激活的存檔的Key，和上面一條命令中輸入的參數相同；--saveas參數后面指定您期望將這個存檔保存到本地的文件路徑。請確定您輸入的文件路徑在本地不存在，如果是本地已存在的文件，這個文件將會被覆蓋
./uarchivemgr-linux64 DownloadArchive --vault test-u2 --archive config.cfg --saveas ./config.cfg.bk
# 如果您不是想下載這個存檔(Archive)，而只想獲得這個存檔(Archive)的URL，您可以使用如下命令，會顯示它的URL，文件并不會被下載。請注意，在當前版本--saveas參數不能省略，這是一個BUG，我們將在稍后的版本修正它
./uarchivemgr-linux64 DownloadArchive --vault test-u2 --archive config.cfg --saveas ./config.cfg --showurl

# 刪除存檔(DownloadArchive)

# 刪除一個存檔(Archive) 必須指定--vault --archive。
./uarchivemgr-linux64 DeleteArchive --vault test-u2 --archive config.cfg

#同步文件夾(Sync)

# 同步一個文件夾下的所有內容到服務器端，必須指定--vault和--dir，其中--dir后面指定一個本地的文件夾路徑，可以是相對路徑也可以是絕對路徑。另外，由于在同步文件夾過程中，無法為每一個文件指定對應的存檔名稱(Archive Key)，工具會默認為文件夾中的每一個文件使用該文件的絕對路徑作為對應的存檔名稱(Archive Key)
./uarchivemgr-linux64 Sync --vault test-u2 --dir /root/testdir/
# 執行該命令之后得到的列表是下面這個樣子，其中每個存檔(Archive)的Key都是該文件在本地的絕對路徑。注意: 服務端只使用這個路徑字符串作為標識符，并不會真的用這個路徑來保存存檔(Archive)。
{
        VaultName:    test-u2
        Key:          /home/marvin/uarchieve/uarchivemgr_linux64.elf/config.cfg
        Hash:         AQAAALYX2XqoLlhkvFiBes1z04GAXbT0
        MimeType:     application/octet-stream
        Size:         278
        Created:      1556440367
        Modified:     1556440367
}

{
        VaultName:    test-u2
        Key:          /home/marvin/uarchieve/uarchivemgr_linux64.elf/uarchivemgr-linux64
        Hash:         AwAAAEBBQhnkmBulZ0iKMnslstJQ-qat
        MimeType:     application/octet-stream
        Size:         9456469
        Created:      1556440370
        Modified:     1556440370
}

# 電子簽名(ETag)

# 這個功能用來計算本地文件的電子簽名(ETag)，通過對比GetArchiveList中得到的已上傳存檔的電子簽名(ETag)，可以方便的知道文件上傳過程中有沒有出錯。必須指定--file選項，其后為本地文件路徑
./uarchivemgr-linux64 ETag --file ./config.cfg

# 獲得幫助(Help)

# 對于所有的命令，您都可以使用help來獲取對應的幫助信息，目前只支持英文版本
./uarchivemgr-linux64 version --help
./uarchivemgr-linux64 GetArchiveList --help
./uarchivemgr-linux64 DeleteVault --help
./uarchivemgr-linux64 DescribeVault --help
./uarchivemgr-linux64 CreateVault --help
./uarchivemgr-linux64 DeleteArchive --help
./uarchivemgr-linux64 ActivateArchive --help
./uarchivemgr-linux64 DownloadArchive --help
./uarchivemgr-linux64 MDownloadArchive --help
./uarchivemgr-linux64 PutArchive --help
./uarchivemgr-linux64 MputArchive --help
./uarchivemgr-linux64 Sync --help
./uarchivemgr-linux64 ETag --help

# 高級功能(Advanced Function)

# 在使用Put或Sync功能上傳文件夾時，可以通過指定--prefix來指定文件前綴，只有文件的前綴與該選項所指定的前綴相同的文件會被上傳。例如下面的命令，會上傳/home/marvin/uarchive-test文件夾下所有前綴為demo的文件
./uarchivemgr-linux64 PutArchive --vault test-u2 --dir /home/marvin/uarchive-test --prefix demo

# 在使用Put或Sync功能上傳文件夾時，可以使用--followsym選項來上傳符號鏈接(Symbol link)所指向的文件，而不是符號鏈接本身
./uarchivemgr-linux64 PutArchive --vault test-u2 --dir /home/marvin/uarchive-test --followsym

# 在使用Put或Sync功能上傳文件夾時，默認會使用文件的全路徑作為存檔名(Archive Key)，可以使用--trimpath來修改這個行為。如果附帶了--trimpath這個選項，那么將會使用文件的名字(File Name)而不是全路徑(Full Path)作為存檔名(Archive Key)
./uarchivemgr-linux64 PutArchive --vault test-u2 --dir /home/marvin/uarchive-test --trimpath

# 更多其他功能請參考幫助(Help)

實施文檔歡迎https://docs.ucloud.cn/uarchive/quick