閱讀879 返回首頁    go 阿裏雲 go 技術社區[雲棲]


接口說明__API使用手冊_歸檔存儲-阿裏雲

4.1.1 創建Vault(PUT)

描述

此操作能夠用指定名稱創建一個新的 Vault,該名稱在同一賬戶的同一Region下是唯一的。同一個賬號在同一Region下最多隻能擁有10個Vault。

當用戶提交創建Vault請求且創建成功時,會返回該Vault對應的Vault ID。

創建 Vault 需要遵守如下規範:

  • 隻能包含小寫字母、數字、下劃線(_)、短橫線(-)。
  • 必須以小寫字母或者數字開頭和結尾。
  • 長度必須在 3-63 字節之間。

發送 HTTP PUT 請求,就可以完成 Vault 的創建。

請求參數

請求頭部

無,其他公共請求頭部參見2.4.1

請求體

返回頭部

名稱 描述
Location 該Vault對應的URI
x-oas-vault-id 該Vault的ID

其他公共返回頭部參見2.4.2

返回體

示例

請求示例

  1. PUT /vaults/[VaultName] HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. x-oas-version: 2014-01-01
  5. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 201 Created
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. Location: /vaults/[VaultId]
  5. x-oas-vault-id: [VaultId]

4.1.2 刪除Vault(DELETE)

描述

此操作是為刪除一個空的Vault。空的Vault是指:

  1. 係統最近一次定期檢索的結果顯示該 Vault 中已經不存在 Archive

  2. 自最近一次檢索結果生成的時間至今,該 Vault 沒有新的文檔寫入

請求參數

請求頭部

無,其他公共請求頭部參見2.4.1

請求體

返回頭部

無,其他公共返回頭部參見2.4.2

返回體

示例

請求示例

  1. DELETE /vaults/[VaultId] HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. x-oas-version: 2014-01-01
  5. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 204 No Content
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT

4.1.3 獲取Vault信息(GET)

描述

此操作返回的Vault信息包括:VaultName,Vault創建時間,Archive數,Archive總大小等。歸檔存儲每天定時掃描生成一次Vault索引緩存。如果用戶添加或者刪除一個Archive之後,立即發起獲取Vault信息的請求,則該請求的響應很可能不會反映這次改變。

請求參數

請求頭部

無,其他公共請求頭部參見2.4.1

請求體

返回頭部

無,其他公共返回頭部參見2.4.2

返回體

  • CreationDate

Vault 的創建時間

  • LastInventoryDate

歸檔存儲對該Vault最近的一次索引緩存時間

  • NumberOfArchives

最近一次檢索時Vault的Archive數

  • SizeInBytes

最近一次檢索時Vault的Archive大小總和

  • VaultId

Vault的ID

  • VaultName

Vault的名稱

示例

請求示例

  1. GET /vaults/[VaultId] HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:02:00 GMT
  4. x-oas-version: 2014-01-01
  5. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 200 OK
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2012 12:02:00 GMT
  4. Content-Type: application/json
  5. Content-Length: 260
  6. {
  7. "CreationDate": "Tue, 25 Mar 2014 12:00:00 GMT",
  8. "LastInventoryDate": "Tue, 25 Mar 2014 12:00:00 GMT",
  9. "NumberOfArchives": 192,
  10. "SizeInBytes": 78088912,
  11. "VaultId": "79D2D8F33B7C287037286185863B6823",
  12. "VaultName": "myvault"
  13. }

4.1.4 獲取Vault列表(GET)

描述

此操作會列出該用戶擁有的全部Vault信息。

默認情況下,此操作返回的列表中最多會有10個Vault,列表按Vault ID升序排列。用戶應始終檢查返回體中的Marker字段,該字段可以在新的請求中作為獲取下一個列表的起點;如果Marker為””(空串),則表示列表已全部獲取完成。用戶還可以通過設置limit參數來限製每次請求返回的Vault數量,但是limit不能超過10,如果超過10,按10處理。

請求參數

請求頭部

無,其他公共請求頭部參見2.4.1

請求體

返回頭部

無,其他公共返回頭部參見2.4.2

返回體

  • Marker

下一次列表請求的起始標記,空串(””)表示無後續的列表

  • VaultList

Vault元數據數組,以下是元數據的字段

  • CreationDate

Vault的創建時間

  • LastInventoryDate

歸檔存儲對該Vault最近的一次檢索緩存時間

  • NumberOfArchives

最近一次檢索時Vault的Archive數

  • SizeInBytes

最近一次檢索時Vault的Archive大小總和

  • VaultId

Vault 的 ID

  • VaultName

Vault 的名稱

示例

請求示例

  1. GET /vaults HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. x-oas-version: 2014-01-01
  5. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 200 OK
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. Content-Type: application/json
  5. Content-Length: 497
  6. {
  7. "Marker": "",
  8. "VaultList":
  9. [{
  10. "CreationDate": "Tue, 18 Mar 2014 22:06:47 GMT",
  11. "LastInventoryDate": "Tue, 18 Mar 2014 12:00:00 GMT",
  12. "NumberOfArchives": 2,
  13. "SizeInBytes": 12334,
  14. "VaultId": "79D2D8F33B7C287037286185863B6823",
  15. "VaultName": "myvault1"
  16. },
  17. {
  18. "CreationDate": "Tue, 18 Mar 2014 22:06:47 GMT ",
  19. "LastInventoryDate": "Tue, 18 Mar 2014 12:00:00 GMT",
  20. "NumberOfArchives": 0,
  21. "SizeInBytes": 0,
  22. "VaultId": "ADD2D8F33B7C287037286185863B68D3",
  23. "VaultName": "myvault2"
  24. },
  25. {
  26. "CreationDate": "Tue, 18 Mar 2014 22:06:47 GMT ",
  27. "LastInventoryDate": "Tue, 18 Mar 2014 12:00:00 GMT",
  28. "NumberOfArchives": 0,
  29. "SizeInBytes": 0,
  30. "VaultId": "FDD2D8F33B7C287037286185863B68D3",
  31. "VaultName": "myvault3"
  32. }]
  33. }

帶limit的請求示例

  1. GET /vaults?limit=2 HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. x-oas-version: 2014-01-01
  5. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 200 OK
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. Content-Type: application/json
  5. Content-Length: 497
  6. {
  7. "Marker": "FDD2D8F33B7C287037286185863B68D3",
  8. "VaultList":
  9. [{
  10. "CreationDate": "Tue, 18 Mar 2014 22:06:47 GMT",
  11. "LastInventoryDate": "Tue, 18 Mar 2014 12:00:00 GMT",
  12. "NumberOfArchives": 2,
  13. "SizeInBytes": 12334,
  14. "VaultId": "79D2D8F33B7C287037286185863B6823",
  15. "VaultName": "myvault1"
  16. },
  17. {
  18. "CreationDate": "Tue, 18 Mar 2014 22:06:47 GMT",
  19. "LastInventoryDate": "Tue, 18 Mar 2014 12:00:00 GMT",
  20. "NumberOfArchives": 0,
  21. "SizeInBytes": 0,
  22. "VaultId": "ADD2D8F33B7C287037286185863B68D3",
  23. "VaultName": "myvault2"
  24. }]
  25. }

帶limit和marker的請求示例

  1. GET /vaults?limit=2&marker=FDD2D8F33B7C287037286185863B68D3
  2. HTTP/1.1
  3. Host: cn-hangzhou.oas.aliyuncs.com
  4. Date: Tue, 25 Mar 2014 12:00:00 GMT
  5. x-oas-version: 2014-01-01
  6. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 200 OK
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. Content-Type: application/json
  5. Content-Length: 497
  6. {
  7. "Marker": "",
  8. "VaultList":
  9. [{
  10. "CreationDate": "Tue, 18 Mar 2014 22:06:47 GMT",
  11. "LastInventoryDate": "Tue, 18 Mar 2014 12:00:00 GMT",
  12. "NumberOfArchives": 0,
  13. "SizeInBytes": 0,
  14. "VaultId": "FDD2D8F33B7C287037286185863B68D3",
  15. "VaultName": "myvault3"
  16. }]
  17. }

4.2 Archive操作

4.2.1 上傳Archive(POST)

描述

此操作是為了上傳單個文檔到Vault中,上傳時需要指定該文檔的校驗碼,校驗碼必須包含x-oas-content-etag和x-oas-tree-etag兩類,校驗碼計算方法參見2.5.1和2.5.2。成功上傳之後,歸檔存儲會返回一個Archive ID,用戶可以通過這個Archive ID訪問該Archive。除了x-oas-archive-description參數外,歸檔存儲不支持其他與該Archive有關的描述信息,Archive ID也不能用於反映文檔的內容。用戶不能用x-oas-archive-description檢索Archive。需要注意的是,如果上傳的文檔大小超過Content-Length指定的字節長度,歸檔存儲隻會讀取Content-Length指定字節長度的數據;小於Content-Length,會返回錯誤。此操作限製文檔上傳的大小為6442450944(6GB),如果超過該大小,必須使用Multipart Upload(4.3)方式。

請求參數

請求頭部

名稱 是否必須 描述
Content-Length 文檔的長度,以字節為單位
x-oas-archive-description 上傳文檔的描述信息,這個字段可以不唯一,長度不超過128字節
x-oas-content-etag 上傳文檔的MD5校驗碼,用於歸檔存儲檢查接收的文件是否完整,計算方法參見2.5.1
x-oas-tree-etag 上傳文檔的tree-hash校驗碼,用於歸檔存儲檢查接收的文件是否完整,計算方法參見2.5.2

其他公共請求頭部參見2.4.1

請求體

需要上傳的Archive的數據

返回頭部

名稱 描述
Location 上傳文檔對應的URI
x-oas-archive-id 上傳文檔的Archive ID

其他公共返回頭部參見2.4.2

返回體

示例

請求示例

  1. POST /vaults/[VaultId]/archives HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. x-oas-content-etag: CAF75EBFF4ED1C8309FE36EA05C97771
  5. x-oas-tree-etag:9D739013ABAE399C173B3C3415BDC69A
  6. x-oas-version: 2014-01-01
  7. Content-Length: 2097152
  8. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 201 Created
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. Location: /vaults/[VaultId]/archives/[ArchiveId]
  5. x-oas-archive-id: [ArchiveId]

4.2.2 刪除Archive(DELETE)

描述

此操作刪除指定Archive。注意如果在刪除Archive之前,用戶已經提交對該Archive的archive-retrieval類型Job(4.4.1),那麼:

  1. 若Job還在進行中,則該Job會失敗。
  2. 若Job已經準備完成,即使刪除成功,用戶依然可以下載該Job Output。但是24小時以後,Job Output不可訪問,並且該Archive也已經刪除。

請求參數

請求頭部

無,其他公共請求頭部參見2.4.1

請求體

返回頭部

無,其他公共返回頭部參見2.4.2

返回體

示例

請求示例

  1. DELETE /vaults/[VaultId]/archives/[ArchiveId]
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date:Tue, 25 Mar 2014 12:00:00 GMT
  4. x-oas-version: 2014-01-01
  5. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 204 No Content
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT

4.3 Multipart Upload操作

4.3.1 初始化Multipart Upload任務(POST)

描述

此操作初始化一個Multipart Upload任務。初始化成功以後,係統會返回它的Upload ID,用戶可以使用該ID 進行後續的Part上傳,單個Multipart Upload任務允許的最大分段數是10000。當用戶初始化該任務時,需要指定Part字節長度,該長度必須大於32MB,且是1MB的整數倍。歸檔存儲限製最小的Part長度是32MB,最大的是4096MB。指定長度時需要將長度值轉換為字節數,如64MB需要轉換成67108864(64*1024*1024)。

用戶上傳文檔的每一段都必須帶上Upload ID,且除了最後一段之外,其餘長度都要求相同。當多段上傳任務完成後,歸檔存儲會清除Upload ID 對應的相關資源,如果用戶自己主動刪除或者該任務自創建24小時以後,該任務將被清除,後續再使用該Upload ID的請求都會失敗。

請求參數

請求頭部

名稱 是否必須 描述
x-oas-part-size 多段上傳文檔的Part長度,以字節為單位
x-oas-archive-description 文檔的描述信息,不超過128字節

其他公共請求頭部參見2.4.1

請求體

返回頭部

名稱 描述
Location Upload ID 的URI,用戶需要根據這個ID,完成多段上傳任務
x-oas-multipart-upload-id Multipart Upload任務的Upload ID

其他公共返回頭部參見2.4.2

返回體

示例

請求示例

  1. POST /vaults/[VaultId]/multipart-uploads
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. x-oas-archive-description: MyArchive
  5. x-oas-part-size: 67108864
  6. x-oas-version: 2014-01-01
  7. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 201 Created
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. Location: /vaults/[VaultId]/multipart-uploads/[UploadId]
  5. x-oas-multipart-upload-id: [UploadId]

4.3.2 獲取Multipart Upload任務列表(GET)

描述

此操作會列出指定Vault中正在進行的Multipart Upload任務。正在進行的Multipart Upload任務是成功啟動Multipart Upload,但尚未完成的任務。默認情況下,此操作返回的列表中最多會有1000個Multipart Upload任務,列表按Upload ID升序排列。用戶應始終檢查返回體中的Marker字段,該字段可以在新的請求中作為獲取下一個列表的起點;如果Marker為””(空串),則表示列表已全部獲取完成。用戶還可以通過設置limit 參數來限製每次請求返回的Multipart Upload任務數量,但是limit 不能超過1000,如果超過1000,按1000處理。

請求參數

名稱 是否必須 描述
limit 指定列表返回數量的上限。如果未指定,則最多會返回1000個Upload任務。當用戶設置大於1000時,當1000處理
marker 指定本次請求列表的起始位置。第一次請求列表時,不需要帶上marker;當返回體提示Marker不為空串(””)時,第二次請求帶上之前返回體中的Marker值就可以獲取後續列表。當marker對應ID不存在時,會報異常。

請求頭部

無,其他公共請求頭部參見2.4.1

請求體

返回頭部

無,其他公共返回頭部參見2.4.2

返回體

  • Marker

下一次列表請求的起始標記,空串(””)表示無後續的列表

  • UploadsList

Multipart Upload請求元數據數組,以下是元數據的字段

  • ArchiveDescription

多段上傳時提供的Archive描述信息

  • CreationDate

多段上傳任務的創建時間

  • PartSizeInBytes

初始化時指定的段大小

  • MultipartUploadId

多段上傳任務的ID

示例

請求示例

  1. GET /vaults/[VaultId]/multipart-uploads HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:10:00 GMT
  4. x-oas-version: 2014-01-01
  5. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 200 OK
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:10:00 GMT
  4. Content-Type: application/json
  5. Content-Length: 451
  6. {
  7. "Marker": "",
  8. "UploadsList":
  9. [{
  10. "ArchiveDescription": "MyArchive1",
  11. "CreationDate": "Tue, 25 Mar 2014 12:02:00 GMT",
  12. "MultipartUploadId”: "28E23B4C061D457094AD16F8D0988826",
  13. "PartSizeInBytes": 68157440
  14. },
  15. {
  16. "ArchiveDescription": "MyArchive2",
  17. "CreationDate": "Tue, 25 Mar 2014 12:02:00 GMT",
  18. "MultipartUploadId": "5RX99B4C061D457894AD16F8D0977737",
  19. "PartSizeInBytes": 68157440
  20. }]
  21. }

帶limit的請求示例

  1. GET /vaults/[VaultId]/multipart-uploads?limit=1 HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:10:00 GMT
  4. x-oas-version: 2014-01-01
  5. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 200 OK
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:10:00 GMT
  4. Content-Type: application/json
  5. Content-Length: 272
  6. {
  7. "Marker": "5RX99B4C061D457894AD16F8D0977737",
  8. "UploadsList":
  9. [{
  10. "ArchiveDescription": "MyArchive1",
  11. "CreationDate": "Tue, 25 Mar 2014 12:02:00 GMT",
  12. "MultipartUploadId": "28E23B4C061D457094AD16F8D0988826",
  13. "PartSizeInBytes": 68157440
  14. }]
  15. }

帶limit和marker的請求示例

  1. GET /vaults/[VaultId]/multipart-uploads?limit=1&marker=5RX99B4C061D457894AD16F8D0977737 HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:10:00 GMT
  4. x-oas-version: 2014-01-01
  5. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 200 OK
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:10:00 GMT
  4. Content-Type: application/json
  5. Content-Length: 240
  6. {
  7. "Marker": "",
  8. "UploadsList":
  9. [{
  10. "ArchiveDescription": "MyArchive2",
  11. "CreationDate": "Tue, 25 Mar 2014 12:02:00 GMT",
  12. "MultipartUploadId": "5RX99B4C061D457894AD16F8D0977737",
  13. "PartSizeInBytes": 68157440
  14. }]
  15. }

4.3.3 刪除Multipart Upload 任務(DELETE)

描述

此操作可以終止並刪除指定的Multipart Upload任務。刪除任務請求成功後,用戶將無法再使用該Upload ID 執行其他Multipart Upload操作。

請求參數

請求頭部

無,其他公共請求頭部參見2.4.1

請求體

返回頭部

無,其他公共返回頭部參見2.4.2

返回體

示例

請求示例

  1. DELETE /vaults/[VaultId]/multipart-uploads/[UploadId] HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. x-oas-version: 2014-01-01
  5. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 204 No Content
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT

4.3.4 Part上傳 (PUT)

描述

此操作會上傳文檔中的一段。用戶可以按任何順序上傳文檔分段。在請求中需要指定Part在整個文檔中的字節範圍,並計算該Part的校驗碼,校驗碼必須包含x-oas-content-etag和x-oas-tree-etag兩類,校驗碼計算方法參見2.5.1和2.5.2。如果上傳的Part大小超過Content-Length指定的字節長度,歸檔存儲隻會讀取Content-Length指定字節長度的數據;小於Content-Length,會返回錯誤。如果Part範圍未對齊或者範圍指定的字節長度與初始化任務時指定的Part字節長度不等(除最後一段),則是一個失敗的請求。例如,如果您指定67108864(64MB)的Part大小,則0-67108863 (64MB-1)以及67108864-1342177287(128MB-1)為有效的段範圍,而2097152-69206015(2MB到66MB-1)、0-66060287(0到63MB-1)和0-68157439(0到65MB-1)都是無效的範圍。

請求參數

請求頭部

名稱 是否必須 描述
Content-Length Part的長度,以字節為單位
Content-Range 標識將在此段中上傳的組裝Archive的字節範圍,歸檔存儲會使用此信息來以正確的順序組裝Archive。
x-oas-content-etag Part的MD5校驗碼,用於檢查接收的Part是否完整,計算方法參見2.5.1
x-oas-tree-etag Part的tree-hash校驗碼,用於檢查接收的Part是否完整,計算方法參見2.5.2

其他公共請求頭部參見2.4.1

請求體

需要上傳的Part的數據

返回頭部

無,其他公共返回頭部參見2.4.2

返回體

示例

請求示例

  1. PUT /vaults/[VaultId]/multipart-uploads/[UploadId] HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. Content-Range: 0-67108863
  5. x-oas-content-etag: FD61CCDFAACA1088CF440B1E822DE1B6
  6. x-oas-tree-etag:9D739013ABAE399C173B3C3415BDC69A
  7. Content-Length: 67108864
  8. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 204 No Content
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT

4.3.5 獲取Part 列表(GET)

描述

默認情況下,此操作返回的列表中最多會有1000個已上傳的Part,列表按Part在文檔中的位置升序排列。用戶應始終檢查返回體中的Marker字段,該字段可以在新的請求中作為獲取下一個列表的起點;如果Marker為””(空串),則表示列表已全部獲取完成。用戶還可以通過設置limit 參數來限製每次請求返回的Part數量,但是limit 不能超過1000,如果超過1000,按1000處理。

請求參數

名稱 是否必須 描述
limit 指定列表返回數量的上限。如果未指定,則最多會返回1000個Job。當用戶設置大於1000時,當1000處理
marker 指定本次請求列表的起始位置。第一次請求列表時,不需要帶上marker;當返回體提示Marker不為空串(””)時,第二次請求帶上之前返回體中的Marker值就可以獲取後續列表。當marker對應ID不存在時,歸檔存儲會返回異常。

請求頭部

無,其他公共請求頭部參見2.4.1

請求體

返回頭部

無,其他公共返回頭部參見2.4.2

返回體

  • ArchiveDescription

多段上傳時提供的Archive描述信息

  • CreationDate

多段上傳任務的創建時間

  • Marker

下一次列表請求的起始標記,空串(””)表示無後續的列表

  • PartSizeInBytes

初始化時指定的Part大小

  • MultipartUploadId

多段上傳任務的ID

  • Parts

Part元數據數組,以下是元數據的字段

  • RangeInBytes

每個Part在文檔中的範圍

  • ContentEtag

Part的校驗碼

示例

請求示例

  1. GET /vaults/[VaultId]/multipart-uploads/[UploadId] HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:10:00 GMT
  4. x-oas-version: 2014-01-01
  5. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 200 OK
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:10:00 GMT
  4. Content-Type: application/json
  5. Content-Length: 362
  6. {
  7. "ArchiveDescription" : "MyArchive",
  8. "CreationDate": "Tue, 25 Mar 2014 12:02:00 GMT",
  9. "Marker": "",
  10. "MultipartUploadId": "840C8218C9374A15A0362F32C508252C",
  11. "PartSizeInBytes": 67108864,
  12. "Parts":
  13. [{
  14. "ContentEtag": "311A6FB47120819937A10E4A98CD08A3",
  15. "RangeInBytes": "0-67108863",
  16. },
  17. {
  18. "ContentEtag": "10D78366CD4B9DE580625E7C67133696",
  19. "RangeInBytes": "67108864-134217727"
  20. }]
  21. }

帶limit請求示例

  1. GET /vaults/[VaultId]/multipart-uploads/[UploadId]?limit=1 HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:10:00 GMT
  4. x-oas-version: 2014-01-01
  5. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 200 OK
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:10:00 GMT
  4. Content-Type: application/json
  5. Content-Length: 280
  6. {
  7. "ArchiveDescription": "MyArchive",
  8. "CreationDate": "Tue, 25 Mar 2014 12:02:00 GMT",
  9. "Marker": "153548",
  10. "MultipartUploadId": "840C8218C9374A15A0362F32C508252C",
  11. "PartSizeInBytes": 67108864,
  12. "Parts":
  13. [{
  14. "ContentEtag": "311A6FB47120819937A10E4A98CD08A3",
  15. "RangeInBytes": "0-67108863"
  16. }]
  17. }

帶limit和marker的請求示例

  1. GET /vaults/[VaultId]/multipart-uploads/[UploadId]?limit=1&marker=153548 HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:10:00 GMT
  4. x-oas-version: 2014-01-01
  5. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 200 OK
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:10:00 GMT
  4. Content-Type: application/json
  5. Content-Length: 281
  6. {
  7. "ArchiveDescription": "MyArchive",
  8. "CreationDate": "Tue, 25 Mar 2014 12:02:00 GMT",
  9. "Marker": "",
  10. "MultipartUploadId": "EACFA05DF334440383E1BABFD88E8749",
  11. "PartSizeInBytes": 67108864,
  12. "Parts":
  13. [{
  14. "ContentEtag": "10D78366CD4B9DE580625E7C67133696",
  15. "RangeInBytes": "67108864-134217727"
  16. }]
  17. }

4.3.6 Part合並(POST)

描述

此操作用於合並已經上傳的Part,並返回新創建的Archive ID。上傳Part時,用戶指定範圍值,用於標識每個Part在整個Archive的位置;合並Part時會檢查是否有任何缺失的數據範圍;如果數據範圍缺失,則會返回錯誤,操作失敗。合並請求需要用戶指定校驗字段,計算方法參見2.5.2。

Part合並是一種冪等的操作。第一次成功完成合並後,如果您在短時間內再次調用該操作,則會成功返回相同的Archive ID。這在您遇到連接中斷或收到500服務器錯誤時很有用,在這種情況下,您可以重複您的Part合並請求並獲取相同的Archive ID,而避免創建重複的Archive。但是,請注意,在合並Part以後,您不能再對之前的Part進行操作,並且Part將不會出現在後續獲取到的Part列表中,即使可能冪等完成也是如此。

請求參數

請求頭部

名稱 是否必須 描述
x-oas-archive-size 文檔的長度,以字節為單位
x-oas-tree-etag Part合並校驗字段,計算方法參見2.5.2

其他公共請求頭部參見2.4.1

請求體

返回頭部

名稱 描述
Location 已經合並的文檔URI 路徑
x-oas-archive-id Archive ID,這個值也被置於Location中

其他公共返回頭部參見2.4.2

返回體

示例

請求示例

  1. POST /vaults/[VaultId]/multipart-uploads/[UploadId] HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. x-oas-archive-size: 201327235
  5. x-oas-tree-etag: AF8B6ED0A292020016639954C558629F-67108864
  6. x-oas-version: 2014-01-01
  7. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 201 Created
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. Location: /vaults/[VaultId]/archives/[ArchiveId]
  5. x-oas-archive-id: ArchiveId

4.4 Job 操作

4.4.1 初始化Job任務(POST)

描述

此操作用於新建指定類型的Job任務,類型有archive-retrieval、inventory-retrieval、pull-from-oss和push-to-oss四種。其中archive-retrieval對應的Job Output是可下載的Archive數據,inventory-retriveval對應的Job Output是Archive列表, pull-from-oss對應的Job執行結果是歸檔存儲直接將用戶OSS上的Object遷移到歸檔存儲上,push-to-oss對應的Job執行結果是歸檔存儲直接將用戶的數據遷移到用戶指定的OSS Bucket。 pull-from-oss與push-to-oss兩種類型的Job屬於跨產品數據傳輸,用戶務必要授權歸檔存儲對用戶OSS的訪問權限。 Job的創建與執行是兩個異步的過程:

  1. 新建指定類型Job,新建Job成功以後,Job進入數據準備狀態,服務端會返回對應的Job ID。
  2. Job執行完成後:如果Job類型為archive-retrieval和inventory-retrieval,用戶可下載Job Output;如果Job類型為pull-from-oss用戶的OSS數據會遷移到歸檔存儲上;如果Job類型為push-to-oss,用戶在歸檔存儲上的數據會遷移到OSS上。
  3. Job自準備完成,保留24個小時的有效期,超出以後,Job不可再訪問。

請求參數

請求頭部

無,其他公共請求頭部參見2.4.1

請求體

  • ArchiveId

需要下載的Archive ID,當Job類型為inventory-retrieval或pull-from-oss時,則不需要此參數

  • Description

Job描述信息,非必需

  • Type

Job的類型,分archive-retrieval,inventory-retrieval,pull-from-oss和push-to-oss四種類型

  • RetrievalByteRange

archive-retrieval類型Job需要取出的數據字節範圍,格式為”StartByte-EndByte”,StartByte必須能夠被1MB整除;EndBytes加1,必須能夠被1MB或Archive總字節數整除。如果不指定該字段,默認取回全部Archive。

如果該字段不符合格式,或在inventory-retrieval類型Job中指定該字段,請求會返回錯誤。當Job類型為pull-from-oss或push-to-oss類型,則不需要此參數。

  • OSSHost

pull-from-oss,push-to-oss類型Job需要指明OSS的域名,該OSS域名必須為阿裏雲內網域名,且與所訪問歸檔存儲的域名在同一region, 如: 用戶訪問歸檔存儲的域名為cn-hangzhou.oas-internal.aliyuncs.com,則oss-cn-hangzhou-internal.aliyuncs.com是合法的OSS域名,而oss-cn-beijing-internal.aliyuncs.com,oss-cn-hangzhou.aliyuncs.com為不支持的OSS域名。當Job類型為archive-retrieval或inventory-retrieval類型,則不需要此參數。

  • Bucket

pull-from-oss,push-to-oss類型Job需要指明OSS的Bucket,用戶需要確保該Bucket已經對OAS授予了訪問權限。當Job類型為archive-retrieval或inventory-retrieval類型,則不需要此參數。

  • Object

pull-from-oss,push-to-oss類型Job需要指明所需要遷移的對象存儲OSS的Object。 用戶需要注意的是,提交push-to-oss類型Job,需要確保不出現重名的Object,否則,該Object會被覆蓋。當Job類型為archive-retrieval或inventory-retrieval類型,則不需要此參數。

返回頭部

名稱 描述
Location 已經合並的文檔URI路徑
x-oas-job-id Job的ID,這個值也被置於Location

其他公共返回頭部參見2.4.2

返回體

示例

請求示例

  1. POST /vaults/[VaultId]/jobs HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. x-oas-version: 2014-01-01
  5. Authorization: [SignatureValue]
  6. {
  7. "Type": "archive-retrieval",
  8. "ArchiveId": "ArchiveId",
  9. "Description": "MyArchive",
  10. "RetrievalByteRange": "0-1024"
  11. }

  1. {
  2. "Type": "inventory-retrieval",
  3. "Description": "MyInventory"
  4. }

  1. {
  2. "Type": "pull-from-oss",
  3. "Description": "My First pull-from-oss Archive",
  4. "OSSHost": "cn-hangzhou.oas-internal.aliyuncs.com",
  5. "Bucket": "oastest",
  6. "Object": "smallfile"
  7. }

  1. {
  2. "Type": "push-to-oss",
  3. "Description": "My First push-to-oss Archive",
  4. "OSSHost": "cn-hangzhou.oas-internal.aliyuncs.com",
  5. "Bucket": "oastest",
  6. "ArchiveId": "BD2FBC11A9D078CE50E95396EDD4BDCAD5AB7E0380DA4587B872B4F5B99ADCAD3E855350FBBDDFD4D8FDD2974BF68783AD8B2321692A5F6F65E02815D9170C33",
  7. "Object": "BD2FBC11A"
  8. }

返回示例

  1. HTTP/1.1 202 Accepted
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. Location: /vaults/[VaultId]/jobs/[JobID]
  5. x-oas-job-id: [JobID]

4.4.2 Job Output下載(GET)

描述

此操作用於下載已經完成的Job結果。Job類型為archive-retrieval ,則可下載內容為Archive數據;Job類型為inventory-retrieval,則可下載內容為指定Vault下的Archive列表,該Archive列表數據是由係統每天定期更新生成的,不是實時數據。支持帶Range(數據範圍)的下載,不指定範圍則返回整個Job結果。Range的格式參考下麵“請求頭部”的說明,如果請求的Range不符合範圍規範,會返回錯誤。Job自準備完成,保留24個小時的有效期,超出以後,Job不可再訪問。pull-from-oss,push-to-oss類型Job不能調用該接口,否則會報參數錯誤。

請求參數

請求頭部

名稱 是否必須 描述
Range 下載時,可以指定要下載的範圍,格式為”StartByte-EndByte”,StartByte必須能夠被1MB整除;EndBytes加1,必須能夠被1MB或Job Output總字節數整除,如bytes=0-1048575。對於archive-retrieval Job來說,該範圍是相對於初始化Job任務時指定的RetrievalByteRange。
如果任務輸出量很大,則您可以使用Range請求頭部來取回輸出的一部分。這樣,您能夠以較小的字節區塊下載整個輸出。
例如,假設您有1GB的Job Output需要下載,您決定一次下載128MB數據區塊,則總共需要八個Job Output下載請求。您將使用以下流程下載任務輸出:
  1. 通過使用Range請求頭部指定相應的字節範圍來下載128MB輸出區塊。
  2. 對輸出數據的所有八個128MB區塊重複執行步驟1,每次都指定相應的字節範圍。

其他公共請求頭部參見2.4.1

請求體

返回頭部

名稱 描述
Content-Length 下載數據的長度,以字節為單位
Content-Range 如果隻下載了一部分,則響應會提供返回的字節範圍。如bytes=0-1048575/8388608表示從8MB的Job Output返回前1MB。
Content-Type 內容類型取決於任務輸出是Archive還是Vault列表內容。
  • 對於Archive數據,Content-Type為”application/octet-stream”。
  • 對於Vault列表內容,以JSON格式返回,Content-Type為”application/json”。
x-oas-tree-etag 對於archive-retrieval類型的Job,在Job指定範圍滿足tree-hash樹對齊(2.5.4)條件下,歸檔存儲會返回tree-hash校驗碼;如果沒有對齊則無此頭部。對於inventory-retrieval類型Job,無此頭部。

其他公共返回頭部參見2.4.2

返回體

如果Job類型是archive-retrieval,則返回體為下載的Archive數據

如果Job類型是inventory-retrieval,則有如下字段的輸出:

  • VaultId

Vault的ID

  • InventoryDate

Vault上次更新信息緩存的GMT日期和時間,信息由歸檔存儲係統每天定期更新

  • ArchiveList

Archive元數據數組。數組中的每個數據元均表示Vault中包含的一個Archive的元數據,元數據的內容由以下的字段組成

  • ArchiveDescription

Archive描述

  • ArchiveId

Archive的ID

  • ArchiveTreeEtag

Archive的tree-hash校驗碼

  • CreationDate

創建Archive的GMT日期和時間

  • Size

Archive大小(以字節為單位)

示例

如下是archive-retrieval Job 請求與返回示例

請求示例

  1. GET /vaults/[VaultId]/jobs/[JobID]/output HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. x-oas-version: 2014-01-01
  5. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 206 Partial Content
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. x-oas-tree-etag: F0C9A541B382F8820D3D19D8E8343A26
  5. Content-Type: application/octet-stream
  6. Content-Length: 1024

如下是archive-retrieval Job 部分段的請求與返回示例

請求示例

  1. GET /vaults/[VaultId]/jobs/[JobID]/output HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. Range: bytes=0-999
  5. x-oas-version: 2014-01-01
  6. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 206 Partial Content
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. x-oas-tree-etag: E0706E072A00E7BBFDC52AEAEE53E428
  5. Content-Range: bytes 0-999/1024
  6. Content-Type: application/octet-stream
  7. Content-Length: 1000

如下是inventory-retrieval Job的請求與返回示例

請求示例

  1. GET /vaults/[VaultId]/jobs/[JobID]/output HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:10:00 GMT
  4. x-oas-version: 2014-01-01
  5. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 200 OK
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:10:00 GMT
  4. Content-Type: application/json
  5. Content-Length: 906
  6. {
  7. "VaultId": "92883B3F278B8EA15CC99EA8763EA129",
  8. "InventoryDate": "Tue, 25 Mar 2014 12:02:00 GMT",
  9. "ArchiveList":
  10. [{
  11. "ArchiveId": "691F43AA453445E48E4FB0A151D7C2F4AA33F44F6B463EA308645C9DCC3D01A318F36DC44B4AC7EC7EDDF0B9210E1924",
  12. "ArchiveTreeEtag": "EEBAACFD27EBC277174D7F160F1864B7",
  13. "ArchiveDescription": "MyArchive1",
  14. "CreationDate": "Tue, 25 Mar 2014 12:02:00 GMT",
  15. "Size": 2140123
  16. },
  17. {
  18. "ArchiveId": "F924432E0616433B966F0D22867B247ECFA3C5317C5177E45A0A24A1BCA1494B772A12DE0D64D16BC2D4D59C721E3679",
  19. "ArchiveTreeEtag": "95FEAC48205C7BC37D9B4AE84E957B0D",
  20. "ArchiveDescription": "MyArchive2",
  21. "CreationDate": "Tue, 25 Mar 2014 12:02:00 GMT",
  22. "Size": 2140123
  23. }]
  24. }

4.4.3 獲取Job列表(GET)

描述

此操作會列出Job列表,包括正在進行的以及近期完成的Job。

默認情況下,此操作返回的列表中最多會有1000個Job,列表按Job ID升序排列。用戶應始終檢查返回體中的Marker字段,該字段可以在新的請求中作為獲取下一個列表的起點;如果Marker為””(空串),則表示列表已全部獲取完成。用戶還可以通過設置limit參數來限製每次請求返回的Job數量,但是limit不能超過1000,如果超過1000,按1000處理。

請求參數

名稱 是否必須 描述
limit 指定列表返回數量的上限。如果未指定,則最多會返回1000個Job。當用戶設置大於1000時,當1000處理
marker 指定本次請求列表的起始位置。第一次請求列表時,不需要帶上marker;當返回體提示Marker不為空串(””)時,第二次請求帶上之前返回體中的Marker值就可以獲取後續列表。當marker對應ID不存在時,會報異常。

請求頭部

無,其他公共請求頭部參見2.4.1

請求體

返回頭部

無,其他公共返回頭部參見2.4.2

返回體

  • Marker

下一次列表請求的起始標記,空串(””)表示無後續的列表

  • JobList

Job元數據數組,以下是元數據的字段

  • Action

任務類型,對於archive-retrieval類型,返回ArchiveRetrieval;對於inventory-retrieval類型,返回InventoryRetrieval;對於pull-from-oss類型,返回PullFromOSS; 對於push-to-oss類型,返回PushToOSS

  • ArchiveId

對於archive-retrieval,push-to-oss任務,該值為創建Job時指定的ArchiveID

對於pull-from-oss任務,Job完成時,該值為OAS生成的ArchiveId;Job未完成時,該值為空串(””)

對於inventory-retrieval任務,該值為空串(””)

  • ArchiveSizeInBytes

如果Job是archive-retrieval,pull-from-oss, push-to-oss類型,Job完成時,該值為創建Job時指定的Archive的大小(以字節為單位)

如果Job是inventory-retrieval類型或者 Job未完成,該值為-1

  • TreeEtag

Job對應範圍的校驗碼,對於inventory-retrieval類型、未完成或者不滿足tree-hash樹對齊(2.5.4)的archive-retrieval類型Job,該值為空串(””)。

  • ArchiveTreeEtag

Archive的校驗碼,對於inventory-retrieval類型或未完成的archive-retrieval,pull-from-oss, push-to-oss類型Job,該值為空串(””)。

  • Completed

指示Job是否完成,Job完成時,用戶可以使用Job Output下載(4.4.2)獲取Job結果

  • CompletionDate

Job請求完成的GMT時間,當Job正在進行時,該值為空串(””)

  • CreationDate

創建Job的GMT時間

  • InventorySizeInBytes

如果Job是inventory-retrieval類型,Job完成時,該值為可下載的Archive列表信息的字節數

如果Job是archive-retrieval,pull-from-oss, push-to-oss類型或者Job未完成,該值為-1

  • JobDescription

創建Job時提供的Job描述

  • JobId

Job ID

  • RetrievalByteRange

初始化archive-retrieval類型Job時指定的Archive需要取出的字節範圍,如果未指定,則返回整個Archive字節範圍, 對於inventory-retrieval,pull-from-oss, push-to-oss類型Job,該字段為空串(””)

  • StatusCode

狀態代碼可以是InProgress、Succeeded或Failed,它指示Job狀態

  • StatusMessage

Job狀態消息

示例

請求示例

  1. GET /vaults/[VaultId]/jobs HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. x-oas-version: 2014-01-01
  5. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 200 OK
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. Content-Type: application/json
  5. Content-Length: 1522
  6. {
  7. "JobList":
  8. [{
  9. "Action": "InventoryRetrieval",
  10. "ArchiveId": "",
  11. "ArchiveSizeInBytes": -1,
  12. "TreeEtag": "",
  13. "ArchiveTreeEtag": "",
  14. "Completed": false,
  15. "CompletionDate": "",
  16. "CreationDate": "Tue, 25 Mar 2014 12:00:00 GMT",
  17. "InventorySizeInBytes": -1,
  18. "JobDescription": "MyJob1",
  19. "JobId": "BE21ED08CE3747A0B8EE4EF401AC9C43",
  20. "StatusCode": "InProgress",
  21. "StatusMessage": "operation in progress"
  22. },
  23. {
  24. "Action": "ArchiveRetrieval",
  25. "ArchiveId": "0BE09D02858A4B13A3624CC6FB10336B79ACA1B5FF4D38F8CAB47E9C7CBD7DDC9667A8BB98BF1D6735495EF5AE046FB9",
  26. "ArchiveSizeInBytes": 123,
  27. "TreeEtag": "DBB87C0A23C894006EA80A386314D003",
  28. "ArchiveTreeEtag": "F0C9A541B382F8820D3D19D8E8343A26",
  29. "Completed": true,
  30. "CompletionDate": " Tue, 25 Mar 2014 11:55:52 GMT",
  31. "CreationDate": "Tue, 25 Mar 2014 08:00:00 GMT",
  32. "InventorySizeInBytes": -1,
  33. "JobDescription": "MyJob2",
  34. "JobId": "D9A741E689E94A078B469E9A9DC03BE9",
  35. "RetrievalByteRange": "0-122",
  36. "StatusCode": "Succeeded",
  37. "StatusMessage": "operation is succeeded"
  38. },
  39. {
  40. "Action": "ArchiveRetrieval",
  41. "ArchiveId": "0BCC996ACD22401A823E44FD553CA823C38A0963C98A1CCCA2B013E5D847F46C675DA67DEC135C292C9C5ECC9D24F2FF",
  42. "ArchiveSizeInBytes": 1024,
  43. "TreeEtag": "DBB87C0A23C894006EA80A386314D003",
  44. "ArchiveTreeEtag": "B78BDC0A23C894006EA80A386314D003",
  45. "Completed": true,
  46. "CompletionDate": "Tue, 25 Mar 2014 11:55:42 GMT",
  47. "CreationDate": "Tue, 25 Mar 2014 08:00:00 GMT",
  48. "InventorySizeInBytes": -1,
  49. "JobDescription": "MyJob3",
  50. "JobId": "DEFB618D721C4FE59D384EACECADEB3E",
  51. "RetrievalByteRange": "0-1023",
  52. "StatusCode": "Succeeded",
  53. "StatusMessage": "operation is succeeded"
  54. }],
  55. "Marker": ""
  56. }

帶limit的請求示例

  1. GET /vaults/[VaultId]/jobs?limit=2 HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. x-oas-version: 2014-01-01
  5. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 200 OK
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. Content-Type: application/json
  5. Content-Length: 1522
  6. {
  7. "JobList":
  8. [{
  9. "Action": "InventoryRetrieval",
  10. "ArchiveId": "",
  11. "ArchiveSizeInBytes": -1,
  12. "TreeEtag": "",
  13. "ArchiveTreeEtag": "",
  14. "Completed": false,
  15. "CompletionDate": "",
  16. "CreationDate": "Tue, 25 Mar 2014 12:00:00 GMT",
  17. "InventorySizeInBytes": -1,
  18. "JobDescription": "MyJob1",
  19. "JobId": "BE21ED08CE3747A0B8EE4EF401AC9C43",
  20. "RetrievalByteRange": "",
  21. "StatusCode": "InProgress",
  22. "StatusMessage": "operation in progress"
  23. },
  24. {
  25. "Action": "ArchiveRetrieval",
  26. "ArchiveId": "0BE09D02858A4B13A3624CC6FB10336B79ACA1B5FF4D38F8CAB47E9C7CBD7DDC9667A8BB98BF1D6735495EF5AE046FB9",
  27. "ArchiveSizeInBytes": 1024,
  28. "TreeEtag": "DBB87C0A23C894006EA80A386314D003",
  29. "ArchiveTreeEtag": "F0C9A541B382F8820D3D19D8E8343A26",
  30. "Completed": true,
  31. "CompletionDate": " Tue, 25 Mar 2014 11:55:52 GMT",
  32. "CreationDate": "Tue, 25 Mar 2014 08:00:00 GMT",
  33. "InventorySizeInBytes": -1,
  34. "JobDescription": "MyJob2",
  35. "JobId": "D9A741E689E94A078B469E9A9DC03BE9",
  36. "StatusCode": "Succeeded",
  37. "StatusMessage": "operation is succeeded"
  38. }],
  39. "Marker": "D9A741E689E94A078B469E9A9DC03BE9"
  40. }

帶limit和marker的請求示例

  1. GET /vaults/[VaultId]/jobs?limit=2&marker=D9A741E689E94A078B469E9A9DC03BE9 HTTP/1.1
  2. Host: cn-hangzhou.oas.aliyuncs.com
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. x-oas-version: 2014-01-01
  5. Authorization: [SignatureValue]

返回示例

  1. HTTP/1.1 200 OK
  2. x-oas-request-id: [RequestId]
  3. Date: Tue, 25 Mar 2014 12:00:00 GMT
  4. Content-Type: application/json
  5. Content-Length: 1522
  6. {
  7. "JobList":
  8. [{
  9. "Action": "ArchiveRetrieval",
  10. "ArchiveId": "0BCC996ACD22401A823E44FD553CA823C38A0963C98A1CCCA2B013E5D847F46C675DA67DEC135C292C9C5ECC9D24F2FF",
  11. "ArchiveSizeInBytes": 1024,
  12. "TreeEtag": "DBB87C0A23C894006EA80A386314D003",
  13. "ArchiveTreeEtag": "B78BDC0A23C894006EA80A386314D003",
  14. "Completed": true,
  15. "CompletionDate": "Tue, 25 Mar 2014 11:55:42 GMT",
  16. "CreationDate": "Tue, 25 Mar 2014 08:00:00 GMT",
  17. "InventorySizeInBytes": -1,
  18. "JobDescription": "MyJob3",
  19. "JobId": "DEFB618D721C4FE59D384EACECADEB3E",
  20. "StatusCode": "Succeeded",
  21. "StatusMessage": "operation is succeeded"
  22. }],
  23. "Marker": ""
  24. }

4.4.4 Job任務狀態查詢(GET)

描述

此操作會返回之前創建的Job信息,包括Job創建日期、類型、狀態代碼、狀態消息等

請求參數

請求頭部

無,其他公共請求頭部參見2.4.1

請求體

返回頭部

無,其他公共返回頭部參見2.4.2

返回體

  • Action

任務類型,對於archive-retrieval類型,返回ArchiveRetrieval

對於inventory-retrieval類型,返回InventoryRetrieval

對於pull-from-oss類型,返回PullFromOSS

對於push-to-oss類型,返回PushToOSS

  • ArchiveId

對於archive-retrieval,push-to-oss任務,該值為創建Job時指定的ArchiveID

對於pull-from-oss任務,Job完成時,該值為歸檔存儲產品生成的ArchiveId;Job未完成時,該值為空串(””)

對於inventory-retrieval任務,該值為空串(””)

  • ArchiveSizeInBytes

如果Job是archive-retrieval,pull-from-oss, push-to-oss類型,Job完成時,該值為創建Job時指定的Archive的大小(以字節為單位)

如果Job是inventory-retrieval類型或者 Job未完成,該值為-1

  • TreeEtag

Job對應範圍的校驗碼,對於inventory-retrieval類型、未完成或者不滿足tree-hash樹對齊(2.5.4)的archive-retrieval類型Job,該值為空串(””)。

  • ArchiveTreeEtag

Archive的校驗碼,對於inventory-retrieval類型或未完成的archive-retrieval,pull-from-oss, push-to-oss類型Job,該值為空串(””)。

  • Completed

指示Job是否完成,Job完成時,用戶可以使用Job Output下載(4.4.2)獲取Job結果

  • CompletionDate

Job請求完成的GMT時間,當Job正在進行時,該值為空串(””)

  • CreationDate

創建Job的GMT時間

  • InventorySizeInBytes

如果Job是inventory-retrieval類型,Job完成時,該值為可下載的Archive列表信息的字節數

如果Job是archive-retrieval,pull-from-oss, push-to-oss類型或者Job未完成,該值為-1

  • JobDescription

創建Job時提供的Job描述

  • JobId

Job ID

<

最後更新:2016-11-24 11:23:47

  上一篇:go API調用方式__API使用手冊_歸檔存儲-阿裏雲
  下一篇:go 文檔更新記錄__API使用手冊_歸檔存儲-阿裏雲