全部产品

接口说明

更新时间:2017-06-07 13:26:11   分享:   

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-etag9D739013ABAE399C173B3C3415BDC69A
  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-etag9D739013ABAE399C173B3C3415BDC69A
  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

  • 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/JobId 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]

返回示例

```HTTP/1.1 200 OKx-oas-request-id: [RequestId]Date: Tue, 25 Mar 2014 12:00:00 GMTContent-Type: application/jsonContent-Length: 443

{ “Action”: “ArchiveRetrieval”, “ArchiveId”: “0BCC996ACD22401A823E44FD553CA823C38A0963C98A1CCCA2B013E5D847F46C675DA67DEC135C292C9C5ECC9D24F2FF”, “ArchiveSizeInBytes”: 1024, “TreeEtag”: “DBB87C0A23C894006EA80A386314D003”, “ArchiveTreeEtag”: “B78BDC0A23C894006EA80A386314D003”, “Completed”: true, “CompletionDate”: “Tue, 25 Mar 2014 11:55:42 GMT”, “CreationDate”: “Tu

本文导读目录
本文导读目录
以上内容是否对您有帮助?