九游平台/ 对象存储服务 obs/ api参考/ api/ / 初始化上传段任务
更新时间:2024-12-28 gmt 08:00

初始化上传段任务-九游平台

功能介绍

使用多段上传特性时,用户必须首先调用创建多段上传任务接口创建任务,系统会给用户返回一个全局唯一的多段上传任务号,作为任务标识。后续用户可以根据这个标识发起相关的请求,如:上传段、合并段、列举段等,了解完整的分段上传流程请参见分段上传。创建多段上传任务不影响已有的同名对象;同一个对象可以同时存在多个多段上传任务;每个多段上传任务在初始化时可以附加消息头信息,包括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?uploadshttp/1.1
host:bucketname.obs.cn-north-4.myhuaweicloud.com
date:date
authorization:authorization

请求消息参数

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

表1 请求消息参数

参数名称

参数类型

是否必选

描述

uploads

string

参数解释:

表明这是多段上传任务。

约束限制:

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

取值范围:

取值为空。

默认取值:

encoding-type

string

参数解释:

用于指定对响应中的key进行指定类型的编码。如果key包含xml 1.0标准不支持的控制字符,可通过设置该参数对响应中的key进行编码。

约束限制:

取值范围:

url

默认取值:

无,不设置则不编码。

请求消息头

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

表2 请求消息头

消息头名称

消息头类型

是否必选

描述

x-obs-acl

string

参数解释:

初始化多段上传任务时,可以加上此消息头设置对象的权限控制策略。

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

约束限制:

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

取值范围:

  • private
  • public-read
  • 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

约束限制:

  • 如果未设置此头域,则以桶的默认存储类型作为对象的存储类型。
  • 设置该参数的值时请注意大小写敏感。

取值范围:

  • standard
  • warm
  • cold
  • deep_archive

默认取值:

继承桶的存储类型

x-obs-persistent-headers

string

参数解释:

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

约束限制:

  • 通过该方式指定的自定义响应头不能以“x-obs-”为前缀,比如可以指定“key1”,但是不能指定“x-obs-key1”。
  • 不能指定http标准头,例如host/content-md5/origin/range/content-disposition等。
  • 此头域和自定义元数据总长度不能超过8kb。
  • 如果传入相同key,将value以“,”拼接后放入同一个key中返回。
  • 如果value解码后存在非us-ascii值或不可识别字符,则服务端只会作为字符串处理并通过“?utf-8?b?<(str)>?=”包装,而不会做解码,例如key1:abbc,会返回key1:=?utf-8?b?abbc?=。
  • value不支持包含的字符“空格”、“=”、“,”、“;”、“:”、".",如果需要包含,请使用url编码或者base64编码。
  • 格式: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”。

取值范围:

默认取值:

x-obs-website-redirect-location

string

参数解释:

当桶设置了website配置,可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的url。

例如,重定向请求到桶内另一对象:

x-obs-website-redirect-location:/anotherpage.html

或重定向请求到一个外部url:

x-obs-website-redirect-location:http://www.example.com/

obs将这个值从头域中取出,保存在对象的元数据“websiteredirectlocation”中。

约束限制:

  • 必须以“/”、“http://”或“https://”开头,长度不超过2kb。
  • obs仅支持为桶根目录下的对象设置重定向,不支持为桶中文件夹下的对象设置重定向。

默认取值:

x-obs-server-side-encryption

string

否。当使用sse-kms方式时,必选。

参数解释:

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

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

约束限制:

取值范围:

  • kms
  • aes256

默认取值:

x-obs-server-side-data-encryption

string

参数解释:

该头域表示对象使用的数据加密算法。

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

约束限制:

仅在sse-kms加密方式下使用该头域。

取值范围:

  • sm4
  • aes256

默认取值:

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

约束限制:

  • 仅在sse-c加密方式下使用该头域。
  • 需要和x-obs-server-side-encryption-customer-key, x-obs-server-side-encryption-customer-key-md5一起使用。

取值范围:

aes256

默认取值:

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

string

否。当使用sse-c方式时,必选。

参数解释:

该头域表示加密使用的密钥,该密钥用于加密对象。

示例:x-obs-server-side-encryption-customer-key:k7qkypbkm5 hca27fsnkunnvaobncnlht/rcb2o/9cw=

约束限制:

  • 仅在sse-c加密方式下使用该头域。
  • 该头域由256-bit的密钥经过base64-encoded得到,需要和x-obs-server-side-encryption-customer-algorithm,x-obs-server-side-encryption-customer-key-md5一起使用。

取值范围:

默认取值:

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

string

否。当使用sse-c方式时,必选。

参数解释:

该头域表示加密使用的密钥的md5值。md5值用于验证密钥传输过程中没有出错。

示例:x-obs-server-side-encryption-customer-key-md5:4xvb3tbntn tieva0/fgaq==

约束限制:

  • 仅在sse-c加密方式下使用该头域。
  • 该头域由密钥的128-bit md5值经过base64-encoded得到,需要和x-obs-server-side-encryption-customer-algorithm,x-obs-server-side-encryption-customer-key一起使用。

取值范围:

密钥id md5的base64值。

默认取值:

x-obs-expires

integer

参数解释:

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

示例:x-obs-expires:3

约束限制:

此字段对于每个对象仅支持上传时配置,不支持后期通过修改元数据接口修改。

取值范围:

大于等于0的整型数,单位:天。

默认取值:

x-obs-tagging

string

参数解释:

以键值对(key-value)的形式指定对象的标签信息,可同时设置多个标签。

示例:x-obs-tagging:taga=a&tagb&tagc

约束限制:

  • key或value包含特殊字符以及“=”、中文字符时,需要进行url编码处理。
  • 如果某项没有“=”,则看作value为空字符串。

取值范围:

默认取值:

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

约束限制:

  • 格式要求为utc时间,并符合iso 8601标准。如:2015-07-01t04:11:15z。
  • 该参数需要和x-obs-object-lock-mode一同使用。

取值范围:

需要大于当前时间。

默认取值:

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.1status_code
date:date
content-length:length
connection:status

xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/">
bucketname
objectname
uploadid

响应消息头

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

表3 附加响应消息头

消息头名称

消息头类型

描述

x-obs-server-side-encryption

string

参数解释:

该头域表示服务端的加密方式。

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

约束限制:

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

取值范围:

  • kms
  • aes256

默认取值:

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所示。

表4 响应消息元素

元素名称

元素类型

描述

initiatemultipartuploadresult

xml

参数解释:

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

约束限制:

取值范围:

默认取值:

bucket

string

参数解释

多段上传任务的桶名。

约束限制:

  • 桶的名字需全局唯一,不能与已有的任何桶名称重复,包括其他用户创建的桶。
  • 桶命名规则如下:
    • 3~63个字符,数字或字母开头,支持小写字母、数字、“-”、“.”。
    • 禁止使用ip地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻(如:“my..bucket”)。
    • 禁止“.”和“-”相邻(如:“my-.bucket”和“my.-bucket”)。
  • 同一用户在同一个区域多次创建同名桶不会报错,创建的桶属性以第一次请求为准。

取值范围:

默认取值:

key

string

参数解释:

多段上传任务的对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径,路径中不包含桶名。

例如,您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中,对象名为folder/test.txt。

约束限制:

参见对象概述

取值范围:

长度大于0且不超过1024的字符。

默认取值:

uploadid

string

参数解释:

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

约束限制:

取值范围:

长度大于0且不超过32的字符串。

默认取值:

encodingtype

string

参数解释:

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

约束限制:

取值范围:

url

默认取值:

无,不设置则不编码。

错误响应消息

  1. 如果accesskey或签名无效,obs返回403 forbidden,错误码为accessdenied。
  2. 如果桶不存在,obs返回404 not found,错误码为nosuchbucket。
  3. 检查用户是否具有指定桶的写权限,如果没有权限,obs返回403 forbidden,错误码为accessdenied。

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

请求示例:初始化段

1
2
3
4
post/objectkey?uploadshttp/1.1
host:examplebucket.obs.cn-north-4.myhuaweicloud.com
date:wed,01jul201505:14:52gmt
authorization:obsakiaiosfodnn7example:vghpcybtzxnzywdlihnpz25lzggiesrlbhzpbmc=

响应示例:初始化段

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
http/1.1200ok
server:obs
x-obs-id-2:weag1lubyrx9e6j5onimru9po4zvknj2qz7/c1npcftwatrpftaofg==
x-obs-request-id:996c76696e6727732072657175657374
date:wed,01jul201505:14:52gmt
content-length:303

xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/">
bucketname
objectkey
dcd2fc98b4f70000013df578aca318e7

请求示例:初始化段的同时携带acl

1
2
3
4
5
post/objectkey?uploadshttp/1.1
host:examplebucket.obs.cn-north-4.myhuaweicloud.com
date:wed,01jul201505:15:43gmt
x-obs-grant-write-acp:id=52f24s3593as5730ea4f722483579ai7,id=a93fcas852f24s3596ea8366794f7224
authorization:obsakiaiosfodnn7example:vghpcybtzxnzywdlihnpz25lzggiesrlbhzpbmc=

响应示例:初始化段的同时携带acl

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
http/1.1200ok
server:obs
x-obs-id-2:32aaaqaaeaabaaaqaaeaabaaaqaaeaabctnv dab51p ivhavwn7s5rskhcwqdfs
x-obs-request-id:bb78000001648457112df37fdfadd7ad
date:wed,01jul201505:15:43gmt
content-length:303

xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/">
bucketname
objectkey
000001648453845dbb78f2340dd460d8

相关文档

网站地图