华为云计算 云知识 初始化上传段任务InitiateMultipartUpload
初始化上传段任务InitiateMultipartUpload

 

接口说明

初始化上传段任务

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

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

URL
POST  https://obs.cn-north-4.myhuaweicloud.com/{object_key} 
请求参数
名称 类型 IN 必选 描述
Authorization
 
string header

请求消息中可带的签名信息。

Date
 
string header

请求发起端的日期和时间,例如:Wed, 27 Jun 2018 13:39:15 +0000。 默认值:无。 条件:如果消息头中带了x-obs-date字段,则可以不带该字段,其他情况下必选。

x-obs-acl
 
string header

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

x-obs-grant-read
 
string header

初始化多段上传任务时,使用此头域授权domain下所有用户有读对象和获取对象元数据的权限 实例x-obs-grant-read: ID=domainID。如果授权给多个租户,需要通过','分割

x-obs-grant-read-acp
 
string header

初始化多段上传任务时,使用此头域授权domain下所有用户有获取对象ACL的权限 实例x-obs-grant-read-acp: ID=domainID。如果授权给多个租户,需要通过','分割

x-obs-grant-write-acp
 
string header

初始化多段上传任务时,使用此头域授权domain下所有用户有写对象ACL的权限。 实例x-obs-grant-write-acp: ID=domainID。如果授权给多个租户,需要通过','分割。

x-obs-grant-full-control
 
string header

初始化多段上传任务时,使用此头域授权domain下所有用户有读对象、获取对象元数据、获取对象ACL、写对象ACL的权限。 实例x-obs-grant-full-control: ID=domainID。如果授权给多个租户,需要通过','分割。

x-obs-storage-class
 
string header

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

类型:字符串

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

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

x-obs-persistent-headers
 
string header

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

类型:字符串

格式: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中返回

x-obs-server-side-encryption
 
string header

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

类型:字符串

示例:x-obs-server-side-encryption:kms 当使用SSE-KMS方式时,必选

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

SSE-KMS方式下使用该头域,该头域表示主密钥,如果用户没有提供该头域,那么默认的主密钥将会被使用。 类型:字符串 支持两种格式的描述方式:

  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
 
string header

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

类型:字符串

示例: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
 
string header

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

类型:字符串

示例:x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hcs27fsNkUnNVaobncnLht/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
 
string header

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

类型:字符串

示例: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 header

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

类型:整型。

示例:x-obs-expires:3

object_key
 
string path

通过此请求创建的对象名称。

bucket_name
 
string query

桶名称

uploads
 
string query

表明这是多段上传任务

encoding-type
 
string query

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

返回参数
返回码: 200

请求成功响应消息。

名称 类型 必选 描述
Content-Length
 
string

响应消息体的字节长度。

Connection
 
string

指明与服务器的连接是长连接还是短连接。

Date
 
string

OBS系统响应的时间。

ETag
 
string

对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识,可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A,下载对象时ETag为B,则说明对象内容发生了变化。实际的ETag是对象的哈希值。ETag只反映变化的内容,而不是其元数据。上传的对象或拷贝操作创建的对象,通过MD5加密后都有唯一的ETag。如果通过多段上传对象,则无论加密方法如何,MD5会拆分ETag,此类情况ETag就不是MD5的摘要。

x-obs-id-2
 
string

帮助定位问题的特殊符号。

x-obs-request-id
 
string

由OBS创建来唯一确定本次请求的值,可以通过该值来定位问题。

x-obs-server-side-encryption
 
string

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

类型:字符串

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

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

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

类型:字符串

格式为: 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
 
string

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

类型:字符串

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

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

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

类型:字符串

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

名称 类型 必选 描述
Bucket
 
string

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

Key
 
string

多段上传对象的key。

UploadId
 
string

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

EncodingType
 
string

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

返回码: 400

请求失败响应消息。

名称 类型 必选 描述
Code
 
string

错误响应消息体XML中错误响应对应的HTTP消息返回码,具体的错误码请参见错误码-表2

Message
 
string

错误响应消息体XML中具体错误更全面、详细的英文解释,具体的错误消息请参见错误码-表2

RequestId
 
string

本次错误请求的请求ID,用于错误定位。

HostId
 
string

返回该消息的服务端ID。

Resource
 
string

该错误相关的桶或对象资源。

返回码: 403

请求失败响应消息。 除了公共的错误码外,此接口还会返回一些其他的错误码。下面列出本接口的一些常见错误,以及可能原因。

错误码 描述 HTTP状态码
AccessDenied AccessKey或签名无效。 403 Forbidden
AccessDenied 用户不具有指定桶的写权限。 403 Forbidden
名称 类型 必选 描述
Code
 
string

错误响应消息体XML中错误响应对应的HTTP消息返回码,具体的错误码请参见错误码-表2

Message
 
string

错误响应消息体XML中具体错误更全面、详细的英文解释,具体的错误消息请参见错误码-表2

RequestId
 
string

本次错误请求的请求ID,用于错误定位。

HostId
 
string

返回该消息的服务端ID。

Resource
 
string

该错误相关的桶或对象资源。

返回码: 404

请求失败响应消息。 除了公共的错误码外,此接口还会返回一些其他的错误码。下面列出本接口的一些常见错误,以及可能原因。

错误码 描述 HTTP状态码
NoSuchBucket 桶不存在。 404 Not Found
名称 类型 必选 描述
Code
 
string

错误响应消息体XML中错误响应对应的HTTP消息返回码,具体的错误码请参见错误码-表2

Message
 
string

错误响应消息体XML中具体错误更全面、详细的英文解释,具体的错误消息请参见错误码-表2

RequestId
 
string

本次错误请求的请求ID,用于错误定位。

HostId
 
string

返回该消息的服务端ID。

Resource
 
string

该错误相关的桶或对象资源。

请求示例
示例 1

初始化段

 
"POST /objectkey?uploads"
 
"POST /objectkey?uploads HTTP/1.1 \nHost: examplebucket.obs.cn-north-4.myhuaweicloud.com\nDate: WED, 01 Jul 2015 05:14:52 GMT \nAuthorization: OBS AKIAIOSFODNN7EXAMPLE:VGhpcyBtZXNzYWdlIHNpZ25lZGGieSRlbHZpbmc="
示例 2

初始化段的同时携带ACL

 
"POST /objectkey?uploads"
 
"POST /objectkey?uploads HTTP/1.1 \nHost: examplebucket.obs.cn-north-4.myhuaweicloud.com\nDate: WED, 01 Jul 2015 05:15:43 GMT\nx-obs-grant-write-acp:ID=52f24s3593as5730ea4f722483579ai7,ID=a93fcas852f24s3596ea8366794f7224\nAuthorization: OBS AKIAIOSFODNN7EXAMPLE:VGhpcyBtZXNzYWdlIHNpZ25lZGGieSRlbHZpbmc="
返回示例
返回码:200

请求成功响应消息。

示例 1
 
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>
错误码
请参考 错误码说明

 

上一篇:什么是Agent 下一篇:CCE