更新时间:2024-03-06 GMT+08:00
分享

初始化上传段任务

功能介绍

使用多段上传特性时,用户必须首先调用创建多段上传任务接口创建任务,系统会给用户返回一个全局唯一的多段上传任务号,作为任务标识。后续用户可以根据这个标识发起相关的请求,如:上传段、合并段、列举段等。创建多段上传任务不影响已有的同名对象;同一个对象可以同时存在多个多段上传任务;每个多段上传任务在初始化时可以附加消息头信息,包括acl、用户自定义元数据和通用的HTTP消息头contentType、contentEncoding等,这些附加的消息头信息将先记录在多段上传任务元数据中。

该操作支持服务端加密功能。

WORM

如果桶的WORM开关是开启的,则可以在初始化多段任务时配置对象级WORM保护策略。您可以通过携带头域x-obs-object-lock-modex-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.cn-north-4.myhuaweicloud.com 
Date: date
Authorization: authorization

请求消息参数

该请求需要在消息中指定参数,表明这是多段上传,参数意义如表1所示。

表1 请求消息参数

参数名称

描述

是否必选

uploads

表明这是多段上传任务。

类型:String

说明:
  • 该参数为空字符串。
  • 如果请求未设置此参数,则为普通POST上传任务。

encoding-type

对响应中的Key进行指定类型的编码。如果Key包含xml 1.0标准不支持的控制字符,可通过设置encoding-type对响应中的Key进行编码。

类型:String

可选值:url

请求消息头

该请求可以使用附加的消息头,具体如表2所示。

表2 请求消息头

消息头名称

描述

是否必选

x-obs-acl

初始化多段上传任务时,可以加上此消息头设置对象的权限控制策略,使用的策略为预定义的常用策略,包括:private;public-read;public-read-write(各策略详细说明见ACL章节的“使用头域设置ACL”)。

类型:String

说明:字符串形式的预定义策略。

实例x-obs-acl: public-read-write。

x-obs-grant-read

初始化多段上传任务时,使用此头域授权domain下所有用户有读对象和获取对象元数据的权限

类型:String

实例x-obs-grant-read: ID=domainID。如果授权给多个租户,需要通过','分割。

x-obs-grant-read-acp

初始化多段上传任务时,使用此头域授权domain下所有用户有获取对象ACL的权限。

类型:String

实例x-obs-grant-read-acp: ID=domainID。如果授权给多个租户,需要通过','分割。

x-obs-grant-write-acp

初始化多段上传任务时,使用此头域授权domain下所有用户有写对象ACL的权限。

类型:String

实例x-obs-grant-write-acp: ID=domainID。如果授权给多个租户,需要通过','分割。

x-obs-grant-full-control

初始化多段上传任务时,使用此头域授权domain下所有用户有读对象、获取对象元数据、获取对象ACL、写对象ACL的权限。

类型:String

实例x-obs-grant-full-control: ID=domainID。如果授权给多个租户,需要通过','分割。

x-obs-storage-class

初始化多段上传任务时,可以加上此头域设置对象的存储类型。如果未设置此头域,则以桶的默认存储类型作为对象的存储类型。

类型:String

说明:存储类型有4种:STANDARD(标准存储)、WARM(低频访问存储)、COLD(归档存储)、DEEP_ARCHIVE(深度归档存储)。因此这里可配置的值有:STANDARD、WARM、COLD、DEEP_ARCHIVE,注意大小写敏感。

示例:x-obs-storage-class: STANDARD

x-obs-persistent-headers

初始化多段上传任务时,可以在HTTP请求中加入“x-obs-persistent-headers”消息头,用来加入一个或多个自定义的响应头,当完成合并段操作后,用户获取此对象或查询此对象元数据时,加入的自定义响应头将会在返回消息的头域中出现。

类型:String

格式:x-obs-persistent-headers: key1:base64_encode(value1),key2:base64_encode(value2)....

说明:其中key1/key2等为自定义header,如果含有非ASCII码或不可识别字符,可以采用URL编码或者Base64编码,服务端只会作为字符串处理,不会做解码。value1/value2等为对应自定义header的值,base64_encode指做base64编码,即将自定义header和对应值的base64编码作为一个key-value对用“:”连接,然后用“,”将所有的key-value对连接起来,放在x-obs-persistent-headers这个header中即可,服务端会对上传的value做解码处理。

示例:x-obs-persistent-headers: key1:dmFsdWUx,key2:dmFsdWU

合并段后,下载此对象或获取此对象元数据时:返回两个头域分别为“key1:value1”“key2:value2”

约束:

  1. 通过该方式指定的自定义响应头不能以“x-obs-”为前缀,比如可以指定“key1”,但是不能指定“x-obs-key1”
  2. 不能指定http标准头,例如host/content-md5/origin/range/Content-Disposition
  3. 此头域和自定义元数据总长度不能超过8KB
  4. 如果传入相同key,将value以“,”拼接后放入同一个key中返回
  5. 如果value解码后存在非US-ASCII值或不可识别字符,则服务端只会作为字符串处理并通过“?UTF-8?B?<(str)>?=”包装,而不会做解码,例如key1:abbc,会返回key1: =?UTF-8?B?abbc?=
  6. value不支持包含的字符“空格”、“=”、“,”、“;”、“:”、".",如果需要包含,请使用URL编码或者Base64编码

x-obs-website-redirect-location

当桶设置了Website配置,可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL,OBS将这个值从头域中取出,保存在对象的元数据中。

类型:String

默认值:无

约束:必须以“/”、“http://”或“https://”开头,长度不超过2K。

x-obs-server-side-encryption

使用该头域表示服务端加密是SSE-KMS方式。

类型:String

示例:x-obs-server-side-encryption:kms

否。当使用SSE-KMS方式时,必选。

x-obs-server-side-data-encryption

SSE-KMS方式下使用该头域,该头域表示对象使用的数据加密算法,有效值为SM4。

类型:String

示例:x-obs-server-side-data-encryption:SM4

x-obs-server-side-encryption-kms-key-id

SSE-KMS方式下使用该头域,该头域表示主密钥,如果用户没有提供该头域,那么默认的主密钥将会被使用。如果默认主密钥不存在,将默认创建并使用。

类型:String

支持两种格式的描述方式:

1. regionID:domainID(租户ID):key/key_id

或者

2.key_id

其中regionID是使用密钥所属region的ID;domainID是使用密钥所属租户的租户ID;key_id是从数据加密服务创建的密钥ID。

示例:

1. x-obs-server-side-encryption-kms-key-id:cn-north-4:domainiddomainiddomainiddoma0001:key/4f1cd4de-ab64-4807-920a-47fc42e7f0d0 或者

2. x-obs-server-side-encryption-kms-key-id:4f1cd4de-ab64-4807-920a-47fc42e7f0d0

x-obs-server-side-encryption-customer-algorithm

SSE-C方式下使用该头域,该头域表示加密使用的算法。

类型:String

示例:x-obs-server-side-encryption-customer-algorithm:AES256

约束:需要和x-obs-server-side-encryption-customer-key, x-obs-server-side-encryption-customer-key-MD5一起使用。

否。当使用SSE-C方式时,必选。

x-obs-server-side-encryption-customer-key

SSE-C方式下使用该头域,该头域表示加密使用的密钥。该密钥用于加密对象。

类型:String

示例:x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=

约束:该头域由256-bit的密钥经过base64-encoded得到,需要和x-obs-server-side-encryption-customer-algorithm,x-obs-server-side-encryption-customer-key-MD5一起使用。

否。当使用SSE-C方式时,必选。

x-obs-server-side-encryption-customer-key-MD5

SSE-C方式下使用该头域,该头域表示加密使用的密钥的MD5值。MD5值用于验证密钥传输过程中没有出错。

类型:String

示例:x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==

约束:该头域由密钥的128-bit MD5值经过base64-encoded得到,需要和x-obs-server-side-encryption-customer-algorithm,x-obs-server-side-encryption-customer-key一起使用。

否。当使用SSE-C方式时,必选。

x-obs-expires

表示对象的过期时间,单位是天。过期之后对象会被自动删除。(从对象最后修改时间开始计算)

类型:Integer

示例:x-obs-expires:3

x-obs-object-lock-mode

要应用于此对象的WORM模式,目前仅支持COMPLIANCE,即合规模式,需要和x-obs-object-lock-retain-until-date一同使用。

类型:String

示例:x-obs-object-lock-mode:COMPLIANCE

否,携带x-obs-object-lock-retain-until-date头域时必带

x-obs-object-lock-retain-until-date

此对象的锁定过期的截止时间,格式要求为UTC时间,并符合ISO 8601标准。如:2015-07-01T04:11:15Z,需要和x-obs-object-lock-mode一同使用。

类型:String

示例:x-obs-object-lock-retain-until-date:2015-07-01T04:11:15Z

否,携带x-obs-object-lock-mode头域时必带

x-obs-meta-*

初始化上传段任务时,可以在HTTP请求中加入以“x-obs-meta-”开头的消息头,用来加入自定义的元数据,以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时,加入的自定义元数据将会在返回消息的头中出现。更多说明详见对象自定义元数据介绍

类型:String

示例:x-obs-meta-test: test metadata

其他公共消息头请参考表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.cn-north-4.myhuaweicloud.com/doc/2015-06-30/"> 
    <Bucket>BucketName</Bucket>  
    <Key>ObjectName</Key>  
    <UploadId>uploadID</UploadId> 
</InitiateMultipartUploadResult> 

响应消息头

该请求的响应消息使用公共消息头,具体请参考表1

表3 附加响应消息头

消息头名称

描述

x-obs-server-side-encryption

如果服务端加密是SSE-KMS方式,响应包含该头域。

类型:String

示例:x-obs-server-side-encryption:kms

x-obs-server-side-encryption-kms-key-id

如果服务端加密是SSE-KMS方式,响应包含该头域,该头域表示主密钥。

类型:String

格式为: regionID:domainID(租户ID):key/key_id

其中regionID是使用密钥所属region的ID;domainID是使用密钥所属租户的租户ID;key_id是本次加密使用的密钥ID。

示例: x-obs-server-side-encryption-kms-key-id:cn-north-4:domainiddomainiddomainiddoma0001:key/4f1cd4de-ab64-4807-920a-47fc42e7f0d0

x-obs-server-side-encryption-customer-algorithm

如果服务端加密是SSE-C方式,响应包含该头域,该头域表示加密使用的算法。

类型:String

示例:x-obs-server-side-encryption-customer-algorithm:AES256

x-obs-server-side-encryption-customer-key-MD5

如果服务端加密是SSE-C方式,响应包含该头域,该头域表示加密使用的密钥的MD5值。

类型:String

示例:x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==

响应消息元素

该请求响应消息中通过返回消息元素,返回本次多段上传任务的多段上传任务号、桶名、对象名,供后续上传段、合并段使用,元素的具体意义如表4所示。

表4 响应消息元素

元素名称

描述

InitiateMultipartUploadResult

描述多段上传任务的容器。

类型:XML

Bucket

多段上传对象所在桶的桶名。

类型:String

Key

多段上传对象的key。

类型:String

UploadId

多段上传id,后面进行多段上传时,利用这个id指定多段上传任务。

类型:String

EncodingType

多段上传对象Key的编码类型。如果请求中设置了encoding-type,那响应中的Key会被编码。

类型:String

错误响应消息

1、如果AccessKey或签名无效,OBS返回403 Forbidden,错误码为AccessDenied。

2、如果桶不存在,OBS返回404 Not Found,错误码为NoSuchBucket。

3、检查用户是否具有指定桶的写权限,如果没有权限,OBS返回403 Forbidden,错误码为AccessDenied。

其他错误已包含在表2中。

请求示例:初始化段

1
2
3
4
POST /objectkey?uploads  HTTP/1.1 
Host: examplebucket.obs.cn-north-4.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.cn-north-4.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.cn-north-4.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.cn-north-4.myhuaweicloud.com/doc/2015-06-30/">  
  <Bucket>bucketname</Bucket>  
  <Key>objectkey</Key>  
  <UploadId>000001648453845DBB78F2340DD460D8</UploadId> 
</InitiateMultipartUploadResult>
分享:

    相关文档

    相关产品