接口说明
Vault操作
创建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
返回体
无
示例
请求示例
PUT /vaults/[VaultName] HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:00:00 GMT
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 201 Created
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:00:00 GMT
Location: /vaults/[VaultId]
x-oas-vault-id: [VaultId]
删除Vault(DELETE)
描述
此操作是为删除一个空的Vault。空的Vault是指:
系统最近一次定期检索的结果显示该 Vault 中已经不存在 Archive
自最近一次检索结果生成的时间至今,该 Vault 没有新的文档写入
请求参数
无
请求头部
无,其他公共请求头部参见2.4.1
请求体
无
返回头部
无,其他公共返回头部参见2.4.2
返回体
无
示例
请求示例
DELETE /vaults/[VaultId] HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:00:00 GMT
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 204 No Content
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:00:00 GMT
获取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的名称
示例
请求示例
GET /vaults/[VaultId] HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:02:00 GMT
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 200 OK
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2012 12:02:00 GMT
Content-Type: application/json
Content-Length: 260
{
"CreationDate": "Tue, 25 Mar 2014 12:00:00 GMT",
"LastInventoryDate": "Tue, 25 Mar 2014 12:00:00 GMT",
"NumberOfArchives": 192,
"SizeInBytes": 78088912,
"VaultId": "79D2D8F33B7C287037286185863B6823",
"VaultName": "myvault"
}
获取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 的名称
示例
请求示例
GET /vaults HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:00:00 GMT
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 200 OK
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:00:00 GMT
Content-Type: application/json
Content-Length: 497
{
"Marker": "",
"VaultList":
[{
"CreationDate": "Tue, 18 Mar 2014 22:06:47 GMT",
"LastInventoryDate": "Tue, 18 Mar 2014 12:00:00 GMT",
"NumberOfArchives": 2,
"SizeInBytes": 12334,
"VaultId": "79D2D8F33B7C287037286185863B6823",
"VaultName": "myvault1"
},
{
"CreationDate": "Tue, 18 Mar 2014 22:06:47 GMT ",
"LastInventoryDate": "Tue, 18 Mar 2014 12:00:00 GMT",
"NumberOfArchives": 0,
"SizeInBytes": 0,
"VaultId": "ADD2D8F33B7C287037286185863B68D3",
"VaultName": "myvault2"
},
{
"CreationDate": "Tue, 18 Mar 2014 22:06:47 GMT ",
"LastInventoryDate": "Tue, 18 Mar 2014 12:00:00 GMT",
"NumberOfArchives": 0,
"SizeInBytes": 0,
"VaultId": "FDD2D8F33B7C287037286185863B68D3",
"VaultName": "myvault3"
}]
}
带limit的请求示例
GET /vaults?limit=2 HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:00:00 GMT
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 200 OK
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:00:00 GMT
Content-Type: application/json
Content-Length: 497
{
"Marker": "FDD2D8F33B7C287037286185863B68D3",
"VaultList":
[{
"CreationDate": "Tue, 18 Mar 2014 22:06:47 GMT",
"LastInventoryDate": "Tue, 18 Mar 2014 12:00:00 GMT",
"NumberOfArchives": 2,
"SizeInBytes": 12334,
"VaultId": "79D2D8F33B7C287037286185863B6823",
"VaultName": "myvault1"
},
{
"CreationDate": "Tue, 18 Mar 2014 22:06:47 GMT",
"LastInventoryDate": "Tue, 18 Mar 2014 12:00:00 GMT",
"NumberOfArchives": 0,
"SizeInBytes": 0,
"VaultId": "ADD2D8F33B7C287037286185863B68D3",
"VaultName": "myvault2"
}]
}
带limit和marker的请求示例
GET /vaults?limit=2&marker=FDD2D8F33B7C287037286185863B68D3
HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:00:00 GMT
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 200 OK
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:00:00 GMT
Content-Type: application/json
Content-Length: 497
{
"Marker": "",
"VaultList":
[{
"CreationDate": "Tue, 18 Mar 2014 22:06:47 GMT",
"LastInventoryDate": "Tue, 18 Mar 2014 12:00:00 GMT",
"NumberOfArchives": 0,
"SizeInBytes": 0,
"VaultId": "FDD2D8F33B7C287037286185863B68D3",
"VaultName": "myvault3"
}]
}
Archive操作
上传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
返回体
无
示例
请求示例
POST /vaults/[VaultId]/archives HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:00:00 GMT
x-oas-content-etag: CAF75EBFF4ED1C8309FE36EA05C97771
x-oas-tree-etag:9D739013ABAE399C173B3C3415BDC69A
x-oas-version: 2014-01-01
Content-Length: 2097152
Authorization: [SignatureValue]
返回示例
HTTP/1.1 201 Created
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:00:00 GMT
Location: /vaults/[VaultId]/archives/[ArchiveId]
x-oas-archive-id: [ArchiveId]
删除Archive(DELETE)
描述
此操作删除指定Archive。注意如果在删除Archive之前,用户已经提交对该Archive的archive-retrieval类型Job(4.4.1),那么:
- 若Job还在进行中,则该Job会失败。
- 若Job已经准备完成,即使删除成功,用户依然可以下载该Job Output。但是24小时以后,Job Output不可访问,并且该Archive也已经删除。
请求参数
无
请求头部
无,其他公共请求头部参见2.4.1
请求体
无
返回头部
无,其他公共返回头部参见2.4.2
返回体
无
示例
请求示例
DELETE /vaults/[VaultId]/archives/[ArchiveId]
Host: cn-hangzhou.oas.aliyuncs.com
Date:Tue, 25 Mar 2014 12:00:00 GMT
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 204 No Content
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:00:00 GMT
Multipart Upload操作
初始化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
返回体
无
示例
请求示例
POST /vaults/[VaultId]/multipart-uploads
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:00:00 GMT
x-oas-archive-description: MyArchive
x-oas-part-size: 67108864
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 201 Created
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:00:00 GMT
Location: /vaults/[VaultId]/multipart-uploads/[UploadId]
x-oas-multipart-upload-id: [UploadId]
获取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
示例
请求示例
GET /vaults/[VaultId]/multipart-uploads HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:10:00 GMT
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 200 OK
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:10:00 GMT
Content-Type: application/json
Content-Length: 451
{
"Marker": "",
"UploadsList":
[{
"ArchiveDescription": "MyArchive1",
"CreationDate": "Tue, 25 Mar 2014 12:02:00 GMT",
"MultipartUploadId”: "28E23B4C061D457094AD16F8D0988826",
"PartSizeInBytes": 68157440
},
{
"ArchiveDescription": "MyArchive2",
"CreationDate": "Tue, 25 Mar 2014 12:02:00 GMT",
"MultipartUploadId": "5RX99B4C061D457894AD16F8D0977737",
"PartSizeInBytes": 68157440
}]
}
带limit的请求示例
GET /vaults/[VaultId]/multipart-uploads?limit=1 HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:10:00 GMT
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 200 OK
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:10:00 GMT
Content-Type: application/json
Content-Length: 272
{
"Marker": "5RX99B4C061D457894AD16F8D0977737",
"UploadsList":
[{
"ArchiveDescription": "MyArchive1",
"CreationDate": "Tue, 25 Mar 2014 12:02:00 GMT",
"MultipartUploadId": "28E23B4C061D457094AD16F8D0988826",
"PartSizeInBytes": 68157440
}]
}
带limit和marker的请求示例
GET /vaults/[VaultId]/multipart-uploads?limit=1&marker=5RX99B4C061D457894AD16F8D0977737 HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:10:00 GMT
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 200 OK
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:10:00 GMT
Content-Type: application/json
Content-Length: 240
{
"Marker": "",
"UploadsList":
[{
"ArchiveDescription": "MyArchive2",
"CreationDate": "Tue, 25 Mar 2014 12:02:00 GMT",
"MultipartUploadId": "5RX99B4C061D457894AD16F8D0977737",
"PartSizeInBytes": 68157440
}]
}
4.3.3 删除Multipart Upload 任务(DELETE)
描述
此操作可以终止并删除指定的Multipart Upload任务。删除任务请求成功后,用户将无法再使用该Upload ID 执行其他Multipart Upload操作。
请求参数
无
请求头部
无,其他公共请求头部参见2.4.1
请求体
无
返回头部
无,其他公共返回头部参见2.4.2
返回体
无
示例
请求示例
DELETE /vaults/[VaultId]/multipart-uploads/[UploadId] HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:00:00 GMT
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 204 No Content
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:00:00 GMT
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
返回体
无
示例
请求示例
PUT /vaults/[VaultId]/multipart-uploads/[UploadId] HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:00:00 GMT
Content-Range: 0-67108863
x-oas-content-etag: FD61CCDFAACA1088CF440B1E822DE1B6
x-oas-tree-etag:9D739013ABAE399C173B3C3415BDC69A
Content-Length: 67108864
Authorization: [SignatureValue]
返回示例
HTTP/1.1 204 No Content
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:00:00 GMT
获取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的校验码
示例
请求示例
GET /vaults/[VaultId]/multipart-uploads/[UploadId] HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:10:00 GMT
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 200 OK
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:10:00 GMT
Content-Type: application/json
Content-Length: 362
{
"ArchiveDescription" : "MyArchive",
"CreationDate": "Tue, 25 Mar 2014 12:02:00 GMT",
"Marker": "",
"MultipartUploadId": "840C8218C9374A15A0362F32C508252C",
"PartSizeInBytes": 67108864,
"Parts":
[{
"ContentEtag": "311A6FB47120819937A10E4A98CD08A3",
"RangeInBytes": "0-67108863",
},
{
"ContentEtag": "10D78366CD4B9DE580625E7C67133696",
"RangeInBytes": "67108864-134217727"
}]
}
带limit请求示例
GET /vaults/[VaultId]/multipart-uploads/[UploadId]?limit=1 HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:10:00 GMT
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 200 OK
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:10:00 GMT
Content-Type: application/json
Content-Length: 280
{
"ArchiveDescription": "MyArchive",
"CreationDate": "Tue, 25 Mar 2014 12:02:00 GMT",
"Marker": "153548",
"MultipartUploadId": "840C8218C9374A15A0362F32C508252C",
"PartSizeInBytes": 67108864,
"Parts":
[{
"ContentEtag": "311A6FB47120819937A10E4A98CD08A3",
"RangeInBytes": "0-67108863"
}]
}
带limit和marker的请求示例
GET /vaults/[VaultId]/multipart-uploads/[UploadId]?limit=1&marker=153548 HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:10:00 GMT
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 200 OK
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:10:00 GMT
Content-Type: application/json
Content-Length: 281
{
"ArchiveDescription": "MyArchive",
"CreationDate": "Tue, 25 Mar 2014 12:02:00 GMT",
"Marker": "",
"MultipartUploadId": "EACFA05DF334440383E1BABFD88E8749",
"PartSizeInBytes": 67108864,
"Parts":
[{
"ContentEtag": "10D78366CD4B9DE580625E7C67133696",
"RangeInBytes": "67108864-134217727"
}]
}
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
返回体
示例
请求示例
POST /vaults/[VaultId]/multipart-uploads/[UploadId] HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:00:00 GMT
x-oas-archive-size: 201327235
x-oas-tree-etag: AF8B6ED0A292020016639954C558629F-67108864
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 201 Created
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:00:00 GMT
Location: /vaults/[VaultId]/archives/[ArchiveId]
x-oas-archive-id: ArchiveId
Job 操作
初始化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的创建与执行是两个异步的过程:
- 新建指定类型Job,新建Job成功以后,Job进入数据准备状态,服务端会返回对应的Job ID。
- Job执行完成后:如果Job类型为archive-retrieval和inventory-retrieval,用户可下载Job Output;如果Job类型为pull-from-oss用户的OSS数据会迁移到归档存储上;如果Job类型为push-to-oss,用户在归档存储上的数据会迁移到OSS上。
- 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
返回体
无
示例
请求示例
POST /vaults/[VaultId]/jobs HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:00:00 GMT
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
{
"Type": "archive-retrieval",
"ArchiveId": "ArchiveId",
"Description": "MyArchive",
"RetrievalByteRange": "0-1024"
}
或
{
"Type": "inventory-retrieval",
"Description": "MyInventory"
}
或
{
"Type": "pull-from-oss",
"Description": "My First pull-from-oss Archive",
"OSSHost": "cn-hangzhou.oas-internal.aliyuncs.com",
"Bucket": "oastest",
"Object": "smallfile"
}
或
{
"Type": "push-to-oss",
"Description": "My First push-to-oss Archive",
"OSSHost": "cn-hangzhou.oas-internal.aliyuncs.com",
"Bucket": "oastest",
"ArchiveId": "BD2FBC11A9D078CE50E95396EDD4BDCAD5AB7E0380DA4587B872B4F5B99ADCAD3E855350FBBDDFD4D8FDD2974BF68783AD8B2321692A5F6F65E02815D9170C33",
"Object": "BD2FBC11A"
}
返回示例
HTTP/1.1 202 Accepted
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:00:00 GMT
Location: /vaults/[VaultId]/jobs/[JobID]
x-oas-job-id: [JobID]
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下载请求。您将使用以下流程下载任务输出:
|
其他公共请求头部参见2.4.1
请求体
无
返回头部
名称 | 描述 |
---|---|
Content-Length |
下载数据的长度,以字节为单位 |
Content-Range |
如果只下载了一部分,则响应会提供返回的字节范围。如bytes=0-1048575/8388608 表示从8MB的Job Output返回前1MB。 |
Content-Type |
内容类型取决于任务输出是Archive还是Vault列表内容。
|
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 请求与返回示例
请求示例
GET /vaults/[VaultId]/jobs/[JobID]/output HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:00:00 GMT
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 206 Partial Content
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:00:00 GMT
x-oas-tree-etag: F0C9A541B382F8820D3D19D8E8343A26
Content-Type: application/octet-stream
Content-Length: 1024
如下是archive-retrieval Job 部分段的请求与返回示例
请求示例
GET /vaults/[VaultId]/jobs/[JobID]/output HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:00:00 GMT
Range: bytes=0-999
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 206 Partial Content
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:00:00 GMT
x-oas-tree-etag: E0706E072A00E7BBFDC52AEAEE53E428
Content-Range: bytes 0-999/1024
Content-Type: application/octet-stream
Content-Length: 1000
如下是inventory-retrieval Job的请求与返回示例
请求示例
GET /vaults/[VaultId]/jobs/[JobID]/output HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:10:00 GMT
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 200 OK
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:10:00 GMT
Content-Type: application/json
Content-Length: 906
{
"VaultId": "92883B3F278B8EA15CC99EA8763EA129",
"InventoryDate": "Tue, 25 Mar 2014 12:02:00 GMT",
"ArchiveList":
[{
"ArchiveId": "691F43AA453445E48E4FB0A151D7C2F4AA33F44F6B463EA308645C9DCC3D01A318F36DC44B4AC7EC7EDDF0B9210E1924",
"ArchiveTreeEtag": "EEBAACFD27EBC277174D7F160F1864B7",
"ArchiveDescription": "MyArchive1",
"CreationDate": "Tue, 25 Mar 2014 12:02:00 GMT",
"Size": 2140123
},
{
"ArchiveId": "F924432E0616433B966F0D22867B247ECFA3C5317C5177E45A0A24A1BCA1494B772A12DE0D64D16BC2D4D59C721E3679",
"ArchiveTreeEtag": "95FEAC48205C7BC37D9B4AE84E957B0D",
"ArchiveDescription": "MyArchive2",
"CreationDate": "Tue, 25 Mar 2014 12:02:00 GMT",
"Size": 2140123
}]
}
获取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状态消息
示例
请求示例
GET /vaults/[VaultId]/jobs HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:00:00 GMT
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 200 OK
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:00:00 GMT
Content-Type: application/json
Content-Length: 1522
{
"JobList":
[{
"Action": "InventoryRetrieval",
"ArchiveId": "",
"ArchiveSizeInBytes": -1,
"TreeEtag": "",
"ArchiveTreeEtag": "",
"Completed": false,
"CompletionDate": "",
"CreationDate": "Tue, 25 Mar 2014 12:00:00 GMT",
"InventorySizeInBytes": -1,
"JobDescription": "MyJob1",
"JobId": "BE21ED08CE3747A0B8EE4EF401AC9C43",
"StatusCode": "InProgress",
"StatusMessage": "operation in progress"
},
{
"Action": "ArchiveRetrieval",
"ArchiveId": "0BE09D02858A4B13A3624CC6FB10336B79ACA1B5FF4D38F8CAB47E9C7CBD7DDC9667A8BB98BF1D6735495EF5AE046FB9",
"ArchiveSizeInBytes": 123,
"TreeEtag": "DBB87C0A23C894006EA80A386314D003",
"ArchiveTreeEtag": "F0C9A541B382F8820D3D19D8E8343A26",
"Completed": true,
"CompletionDate": " Tue, 25 Mar 2014 11:55:52 GMT",
"CreationDate": "Tue, 25 Mar 2014 08:00:00 GMT",
"InventorySizeInBytes": -1,
"JobDescription": "MyJob2",
"JobId": "D9A741E689E94A078B469E9A9DC03BE9",
"RetrievalByteRange": "0-122",
"StatusCode": "Succeeded",
"StatusMessage": "operation is succeeded"
},
{
"Action": "ArchiveRetrieval",
"ArchiveId": "0BCC996ACD22401A823E44FD553CA823C38A0963C98A1CCCA2B013E5D847F46C675DA67DEC135C292C9C5ECC9D24F2FF",
"ArchiveSizeInBytes": 1024,
"TreeEtag": "DBB87C0A23C894006EA80A386314D003",
"ArchiveTreeEtag": "B78BDC0A23C894006EA80A386314D003",
"Completed": true,
"CompletionDate": "Tue, 25 Mar 2014 11:55:42 GMT",
"CreationDate": "Tue, 25 Mar 2014 08:00:00 GMT",
"InventorySizeInBytes": -1,
"JobDescription": "MyJob3",
"JobId": "DEFB618D721C4FE59D384EACECADEB3E",
"RetrievalByteRange": "0-1023",
"StatusCode": "Succeeded",
"StatusMessage": "operation is succeeded"
}],
"Marker": ""
}
带limit的请求示例
GET /vaults/[VaultId]/jobs?limit=2 HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:00:00 GMT
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 200 OK
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:00:00 GMT
Content-Type: application/json
Content-Length: 1522
{
"JobList":
[{
"Action": "InventoryRetrieval",
"ArchiveId": "",
"ArchiveSizeInBytes": -1,
"TreeEtag": "",
"ArchiveTreeEtag": "",
"Completed": false,
"CompletionDate": "",
"CreationDate": "Tue, 25 Mar 2014 12:00:00 GMT",
"InventorySizeInBytes": -1,
"JobDescription": "MyJob1",
"JobId": "BE21ED08CE3747A0B8EE4EF401AC9C43",
"RetrievalByteRange": "",
"StatusCode": "InProgress",
"StatusMessage": "operation in progress"
},
{
"Action": "ArchiveRetrieval",
"ArchiveId": "0BE09D02858A4B13A3624CC6FB10336B79ACA1B5FF4D38F8CAB47E9C7CBD7DDC9667A8BB98BF1D6735495EF5AE046FB9",
"ArchiveSizeInBytes": 1024,
"TreeEtag": "DBB87C0A23C894006EA80A386314D003",
"ArchiveTreeEtag": "F0C9A541B382F8820D3D19D8E8343A26",
"Completed": true,
"CompletionDate": " Tue, 25 Mar 2014 11:55:52 GMT",
"CreationDate": "Tue, 25 Mar 2014 08:00:00 GMT",
"InventorySizeInBytes": -1,
"JobDescription": "MyJob2",
"JobId": "D9A741E689E94A078B469E9A9DC03BE9",
"StatusCode": "Succeeded",
"StatusMessage": "operation is succeeded"
}],
"Marker": "D9A741E689E94A078B469E9A9DC03BE9"
}
带limit和marker的请求示例
GET /vaults/[VaultId]/jobs?limit=2&marker=D9A741E689E94A078B469E9A9DC03BE9 HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:00:00 GMT
x-oas-version: 2014-01-01
Authorization: [SignatureValue]
返回示例
HTTP/1.1 200 OK
x-oas-request-id: [RequestId]
Date: Tue, 25 Mar 2014 12:00:00 GMT
Content-Type: application/json
Content-Length: 1522
{
"JobList":
[{
"Action": "ArchiveRetrieval",
"ArchiveId": "0BCC996ACD22401A823E44FD553CA823C38A0963C98A1CCCA2B013E5D847F46C675DA67DEC135C292C9C5ECC9D24F2FF",
"ArchiveSizeInBytes": 1024,
"TreeEtag": "DBB87C0A23C894006EA80A386314D003",
"ArchiveTreeEtag": "B78BDC0A23C894006EA80A386314D003",
"Completed": true,
"CompletionDate": "Tue, 25 Mar 2014 11:55:42 GMT",
"CreationDate": "Tue, 25 Mar 2014 08:00:00 GMT",
"InventorySizeInBytes": -1,
"JobDescription": "MyJob3",
"JobId": "DEFB618D721C4FE59D384EACECADEB3E",
"StatusCode": "Succeeded",
"StatusMessage": "operation is succeeded"
}],
"Marker": ""
}
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状态消息
示例
请求示例
GET /vaults/[VaultId]/jobs/JobId HTTP/1.1
Host: cn-hangzhou.oas.aliyuncs.com
Date: Tue, 25 Mar 2014 12:00:00 GMT
x-oas-version: 2014-01-01
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