初始化上传段任务
功能介绍
使用多段上传特性时,用户必须首先调用创建多段上传任务接口创建任务,系统会给用户返回一个全局唯一的多段上传任务号,作为任务标识。后续用户可以根据这个标识发起相关的请求,如:上传段、合并段、列举段等。创建多段上传任务不影响已有的同名对象;同一个对象可以同时存在多个多段上传任务;每个多段上传任务在初始化时可以附加消息头信息,包括acl、用户自定义元数据和通用的HTTP消息头contentType、contentEncoding等,这些附加的消息头信息将先记录在多段上传任务元数据中。
该操作支持服务端加密功能。
WORM
如果桶的WORM开关是开启的,则可以在初始化多段任务时配置对象级WORM保护策略。您可以通过携带头域x-obs-object-lock-mode和x-obs-object-lock-retain-until-date在初始化多段任务的同时指定最终合并对象的保护策略,如果您不携带这些头域,但配置了桶级默认WORM策略,则合并后的对象会自动应用默认策略。您还可以在合并后配置或修改对象级WORM保护策略。
与使用PUT和POST方法上传对象不同,多段上传对x-obs-object-lock-retain-until-date头域的约束只需要您提供不晚于初始化时间的日期,而无需晚于合并多段任务的时间。应用桶级默认WORM策略时,保护的起始时间从合并时间开始计算,即合并时间+桶级默认保护期限。在合并前,多段上传任务可以被取消,不会受到WORM功能影响。
请求消息样式
1 2 3 4 |
POST /ObjectName?uploads HTTP/1.1 Host: bucketname.obs.region.myhuaweicloud.com Date: date Authorization: authorization |
请求消息参数
该请求需要在消息中指定参数,表明这是多段上传,参数意义如表1所示。
请求消息头
该请求可以使用附加的消息头,具体如表2所示。
消息头名称 |
消息头类型 |
是否必选 |
描述 |
---|---|---|---|
x-obs-acl |
String |
否 |
参数解释: 初始化多段上传任务时,可以加上此消息头设置对象的权限控制策略。 示例:x-obs-acl:public-read-write。 约束限制: 字符串形式的预定义策略。 取值范围:
各策略详细说明见ACL章节的“使用头域设置ACL”。 默认取值: private |
x-obs-grant-read |
String |
否 |
参数解释: 初始化多段上传任务时,使用此头域授权读对象和获取对象元数据的权限给domain下的所有用户。 示例:x-obs-grant-read: ID=domainID。 约束限制: 如果授权给多个租户,需要通过“,”分割。 取值范围: 无 默认取值: 无 |
x-obs-grant-read-acp |
String |
否 |
参数解释: 初始化多段上传任务时,使用此头域授权获取对象ACL的权限给domain下的所有用户。 示例:x-obs-grant-read-acp: ID=domainID。 约束限制: 如果授权给多个租户,需要通过“,”分割。 取值范围: 无 默认取值: 无 |
x-obs-grant-write-acp |
String |
否 |
参数解释: 初始化多段上传任务时,使用此头域授权写对象ACL的权限给domain下的所有用户。 示例:x-obs-grant-write-acp: ID=domainID。 约束限制: 如果授权给多个租户,需要通过“,”分割。 取值范围: 无 默认取值: 无 |
x-obs-grant-full-control |
String |
否 |
参数解释: 初始化多段上传任务时,使用此头域授权以下权限给domain下的所有用户: 读对象、获取对象元数据、获取对象ACL、写对象ACL的权限。 示例:x-obs-grant-full-control: ID=domainID。 约束限制: 如果授权给多个租户,需要通过“,”分割。 取值范围: 无 默认取值: 无 |
x-obs-storage-class |
String |
否 |
参数解释: 初始化多段上传任务时,可以加上此头域设置对象的存储类型。 示例:x-obs-storage-class: STANDARD 约束限制:
取值范围:
默认取值: 继承桶的存储类型 |
x-obs-persistent-headers |
String |
否 |
参数解释: 初始化多段上传任务时,可以在HTTP请求中加入“x-obs-persistent-headers”消息头,用来加入一个或多个自定义的响应头,当完成合并段操作后,用户获取此对象或查询此对象元数据时,加入的自定义响应头将会在返回消息的头域中出现。 约束限制:
取值范围: 无 默认取值: 无 |
x-obs-website-redirect-location |
String |
否 |
参数解释: 当桶设置了Website配置,可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL。 例如,重定向请求到桶内另一对象: WebsiteRedirectLocation:/anotherPage.html 或重定向请求到一个外部URL: WebsiteRedirectLocation:http://www.example.com/ OBS将这个值从头域中取出,保存在对象的元数据“WebsiteRedirectLocation”中。 约束限制:
默认取值: 无 |
x-obs-server-side-encryption |
String |
否。当使用SSE-KMS方式时,必选。 |
参数解释: 使用该头域表示服务端加密是SSE-KMS方式。 示例:x-obs-server-side-encryption: kms 约束限制: 无 取值范围:
默认取值: 无 |
x-obs-server-side-encryption-kms-key-id |
String |
否 |
参数描述: 当加密方式为SSE-KMS且使用指定密钥加密时,需输入密钥ID。密钥ID获取方法请参见查看密钥。 约束限制: 当您设置了x-obs-server-side-encryption头域且赋值为“kms”,即选择kms加密方式时,才能使用该头域指定加密密钥。 默认取值: 当您选择使用kms加密方式,但未设置此头域时,默认的主密钥将会被使用。如果默认主密钥不存在,系统将默认创建并使用。 |
x-obs-server-side-encryption-customer-algorithm |
String |
否。当使用SSE-C方式时,必选。 |
参数解释: 该头域表示加密使用的算法。 示例:x-obs-server-side-encryption-customer-algorithm: AES256 约束限制:
取值范围: AES256 默认取值: 无 |
x-obs-server-side-encryption-customer-key |
String |
否。当使用SSE-C方式时,必选。 |
参数解释: 该头域表示加密使用的密钥,该密钥用于加密对象。 示例:x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw= 约束限制:
取值范围: 无 默认取值: 无 |
x-obs-server-side-encryption-customer-key-MD5 |
String |
否。当使用SSE-C方式时,必选。 |
参数解释: 该头域表示加密使用的密钥的MD5值。MD5值用于验证密钥传输过程中没有出错。 示例:x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ== 约束限制:
取值范围: 密钥ID MD5的base64值。 默认取值: 无 |
x-obs-expires |
Integer |
否 |
参数解释: 表示对象的过期时间,单位是天。过期之后对象会被自动删除。(从对象最后修改时间开始计算) 示例:x-obs-expires:3 约束限制: 此字段对于每个对象仅支持上传时配置,不支持后期通过修改元数据接口修改。 取值范围: 大于等于0的整型数,单位:天。 默认取值: 无 |
x-obs-object-lock-mode |
String |
否,携带x-obs-object-lock-retain-until-date头域时必带 |
参数解释: 要应用于对象的WORM模式。 示例:x-obs-object-lock-mode:COMPLIANCE 约束限制: 该参数需要和x-obs-object-lock-retain-until-date一同使用。 取值范围: 仅支持COMPLIANCE,即合规模式。 默认取值: 无 |
x-obs-object-lock-retain-until-date |
String |
否,携带x-obs-object-lock-mode头域时必带 |
参数解释: 对象的WORM策略过期的截止时间。 示例:x-obs-object-lock-retain-until-date:2015-07-01T04:11:15Z 约束限制:
取值范围: 需要大于当前时间。 默认取值: 无 |
x-obs-meta-* |
String |
否 |
参数解释: 初始化上传段任务时,可以在HTTP请求中加入以“x-obs-meta-”开头的消息头,用来加入自定义的元数据,以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时,加入的自定义元数据将会在返回消息的头中出现。更多说明详见对象自定义元数据介绍。 示例:x-obs-meta-test: test metadata 约束限制: HTTP请求不包含消息体,长度不能超过8KB。 取值范围: 无 默认取值: 无 |
其他公共消息头请参考表3。
请求消息元素
该请求消息中不使用消息元素。
响应消息样式
1 2 3 4 5 6 7 8 9 10 11 |
HTTP/1.1 status_code Date: date Content-Length: length Connection: status <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <InitiateMultipartUploadResult xmlns="http://obs.region.myhuaweicloud.com/doc/2015-06-30/"> <Bucket>BucketName</Bucket> <Key>ObjectName</Key> <UploadId>uploadID</UploadId> </InitiateMultipartUploadResult> |
响应消息头
该请求的响应消息使用公共消息头,具体请参考表1。
消息头名称 |
消息头类型 |
描述 |
---|---|---|
x-obs-server-side-encryption |
String |
参数解释: 该头域表示服务端的加密方式。 示例:x-obs-server-side-encryption: kms 约束限制: 如果服务端加密是SSE-KMS方式,响应包含该头域。 取值范围:
默认取值: 无 |
x-obs-server-side-encryption-kms-key-id |
String |
参数描述: 当加密方式为SSE-KMS且使用指定密钥加密时,需输入密钥ID。密钥ID获取方法请参见查看密钥。 约束限制: 当您设置了x-obs-server-side-encryption头域且赋值为“kms”,即选择kms加密方式时,才能使用该头域指定加密密钥。 默认取值: 当您选择使用kms加密方式,但未设置此头域时,默认的主密钥将会被使用。如果默认主密钥不存在,系统将默认创建并使用。 |
x-obs-server-side-encryption-customer-algorithm |
String |
参数解释: 该头域表示加密使用的算法。 示例:x-obs-server-side-encryption-customer-algorithm: AES256 约束限制: 如果服务端加密是SSE-C方式,响应包含该头域。 取值范围: AES256 默认取值: 无 |
x-obs-server-side-encryption-customer-key-MD5 |
String |
参数解释: 该头域表示加密使用的密钥的MD5值。 示例:x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ== 约束限制: 如果服务端加密是SSE-C方式,响应包含该头域。 取值范围: 密钥ID MD5的base64值。 默认取值: 无 |
响应消息元素
该请求响应消息中通过返回消息元素,返回本次多段上传任务的多段上传任务号、桶名、对象名,供后续上传段、合并段使用,元素的具体意义如表4所示。
元素名称 |
元素类型 |
描述 |
---|---|---|
InitiateMultipartUploadResult |
XML |
参数解释: 描述多段上传任务的容器。 约束限制: 无 取值范围: 无 默认取值: 无 |
Bucket |
String |
参数解释: 多段上传任务的桶名。 约束限制:
取值范围: 无 默认取值: 无 |
Key |
String |
参数解释: 多段上传任务的对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径,路径中不包含桶名。 例如,您对象的访问地址为examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt 中,对象名为folder/test.txt。 约束限制: 参见对象概述。 取值范围: 长度大于0且不超过1024的字符。 默认取值: 无 |
UploadId |
String |
参数解释: 多段上传任务的ID,后面进行多段上传时,可利用这个ID指定多段上传任务。 约束限制: 无 取值范围: 长度大于0且不超过32的字符串。 默认取值: 无 |
EncodingType |
String |
参数解释: 多段上传对象Key的编码类型。如果请求中设置了encoding-type,那响应中的Key会被编码。 约束限制: 无 取值范围: URL 默认取值: 无,不设置则不编码。 |
错误响应消息
- 如果AccessKey或签名无效,OBS返回403 Forbidden,错误码为AccessDenied。
- 如果桶不存在,OBS返回404 Not Found,错误码为NoSuchBucket。
- 检查用户是否具有指定桶的写权限,如果没有权限,OBS返回403 Forbidden,错误码为AccessDenied。
其他错误已包含在表2中。
请求示例:初始化段
1 2 3 4 |
POST /objectkey?uploads HTTP/1.1 Host: examplebucket.obs.region.myhuaweicloud.com Date: WED, 01 Jul 2015 05:14:52 GMT Authorization: OBS AKIAIOSFODNN7EXAMPLE:VGhpcyBtZXNzYWdlIHNpZ25lZGGieSRlbHZpbmc= |
响应示例:初始化段
1 2 3 4 5 6 7 8 9 10 11 12 13 |
HTTP/1.1 200 OK Server: OBS x-obs-id-2: Weag1LuByRx9e6j5Onimru9pO4ZVKnJ2Qz7/C1NPcfTWAtRPfTaOFg== x-obs-request-id: 996c76696e6727732072657175657374 Date: WED, 01 Jul 2015 05:14:52 GMT Content-Length: 303 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <InitiateMultipartUploadResult xmlns="http://obs.region.myhuaweicloud.com/doc/2015-06-30/"> <Bucket>bucketname</Bucket> <Key>objectkey</Key> <UploadId>DCD2FC98B4F70000013DF578ACA318E7</UploadId> </InitiateMultipartUploadResult> |
请求示例:初始化段的同时携带ACL
1 2 3 4 5 |
POST /objectkey?uploads HTTP/1.1 Host: examplebucket.obs.region.myhuaweicloud.com Date: WED, 01 Jul 2015 05:15:43 GMT x-obs-grant-write-acp:ID=52f24s3593as5730ea4f722483579ai7,ID=a93fcas852f24s3596ea8366794f7224 Authorization: OBS AKIAIOSFODNN7EXAMPLE:VGhpcyBtZXNzYWdlIHNpZ25lZGGieSRlbHZpbmc= |
响应示例:初始化段的同时携带ACL
1 2 3 4 5 6 7 8 9 10 11 12 13 |
HTTP/1.1 200 OK Server: OBS x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAABCTnv+daB51p+IVhAvWN7s5rSKhcWqDFs x-obs-request-id: BB78000001648457112DF37FDFADD7AD Date: WED, 01 Jul 2015 05:15:43 GMT Content-Length: 303 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <InitiateMultipartUploadResult xmlns="http://obs.region.myhuaweicloud.com/doc/2015-06-30/"> <Bucket>bucketname</Bucket> <Key>objectkey</Key> <UploadId>000001648453845DBB78F2340DD460D8</UploadId> </InitiateMultipartUploadResult> |