当前位置:主页 > 查看内容

POST上传_对象存储服务 OBS_API参考_API_对象操作

发布时间:2021-09-09 00:00| 位朋友查看

简介:功能介绍 上传对象操作是指在指定的桶内增加一个对象,执行该操作需要用户拥有桶的写权限。 同一个桶中存储的对象名是唯一的,在桶未开启多版本的情况下,重复上传同名对象,前一次上传的对象将被后一次上传的对象覆盖。 如果在指定的桶内已经有相同的对象键……

功能介绍

上传对象操作是指在指定的桶内增加一个对象,执行该操作需要用户拥有桶的写权限。

同一个桶中存储的对象名是唯一的,在桶未开启多版本的情况下,重复上传同名对象,前一次上传的对象将被后一次上传的对象覆盖。

如果在指定的桶内已经有相同的对象键值的对象,用户上传的新对象会覆盖原来的对象;为了确保数据在传输过程中没有遭到破坏,用户可以在表单域中加入Content-MD5参数。在这种情况下,OBS收到上传的对象后,会对对象进行MD5校验,如果不一致则返回出错信息。用户还可以在上传对象时指定x-obs-acl参数,设置对象的权限控制策略。

用户除了可以用PUT直接上传对象外,还可以使用POST上传对象。

单次上传对象大小范围是[0, 5GB],如果需要上传超过5GB的大文件,需要通过多段操作来分段上传。

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

与PUT上传的区别

PUT上传中参数通过请求头域传递;POST上传则作为消息体中的表单域传递。

PUT上传需在URL中指定对象名;POST上传提交的URL为桶域名,无需指定对象名。两者的请求行分别为:

PUT /ObjectName HTTP/1.1
POST / HTTP/1.1

关于PUT上传的更多详细信息,请参考PUT上传

多版本

如果桶的多版本状态是开启的,系统会自动为对象生成一个唯一的版本号;如果桶的多版本状态是暂停的,则系统生成的对象版本号为null,并由响应报头x-obs-version-id返回该版本号。关于桶的多版本状态,参见设置桶的多版本状态

请求消息样式

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
POST / HTTP/1.1 
Host: bucketname.obs.cn-north-4.myhuaweicloud.com 
User-Agent: browser_data
Accept: file_types
Accept-Language: Regions
Accept-Encoding: encoding
Accept-Charset: character_set
Keep-Alive: 300 
Connection: keep-alive 
Content-Type: multipart/form-data; boundary=9431149156168 
Content-Length: length


--9431149156168 
Content-Disposition: form-data; name="key" 

acl 
--9431149156168 
Content-Disposition: form-data; name="success_action_redirect"
 
success_redirect 
--9431149156168 
Content-Disposition: form-data; name="content-Type" 

content_type 
--9431149156168 
Content-Disposition: form-data; name="x-obs-meta-uuid" 

uuid 
--9431149156168 
Content-Disposition: form-data; name="x-obs-meta-tag" 

metadata 
--9431149156168 
Content-Disposition: form-data; name="AccessKeyId" 

access-key-id 
--9431149156168 
Content-Disposition: form-data; name="policy" 

encoded_policy 
--9431149156168 
Content-Disposition: form-data; name="signature" 

signature= 
--9431149156168 
Content-Disposition: form-data; name="file"; filename="MyFilename" 
Content-Type: image/jpeg 

file_content 
--9431149156168 
Content-Disposition: form-data; name="submit" 

Upload to OBS 
--9431149156168--

请求消息参数

该请求消息中不使用参数。

请求消息头

该请求使用公共的消息头,具体请参见表3

如果想要获取CORS配置信息,则需要使用的消息头如下表1所示。

表1 获取CORS配置的请求消息头

消息头名称

描述

是否必选

Origin

预请求指定的跨域请求Origin(通常为域名)。

类型:字符串

Access-Control-Request-Headers

实际请求可以带的HTTP头域,可以带多个头域。

类型:字符串

请求消息元素

该请求消息的消息元素以表单形式组织,表单字段的具体含义如表2所示。

表2 请求消息表单元素

参数名称

描述

是否必选

file

上传的对象的内容。

类型:二进制或文本类型。

约束条件:此参数必须为最后一个参数,否则此参数之后的参数会被丢弃;一个请求中只能含有一个file参数。

key

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

类型:字符串。

AccessKeyId

用来指明请求发起者的Access Key。

类型:字符串。

约束条件:如果该请求包括安全策略参数,则必须包括此参数。

policy

该请求的安全策略描述。policy格式请参考基于浏览器上传的表单中携带签名章节中policy格式

类型:字符串。

signature

根据StringToSign计算出的签名字符串。

类型:字符串

token

用来统一指明请求发起者的Access Key,请求签名和请求的安全策略。token的优先级高于单独指定的Access Key,请求签名和请求的安全策略。

类型:字符串。

示例:

HTML中:<input type="text" name="token" value="ak:signature:policy" />

x-obs-acl

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

类型:字符串。

示例:

POLICY中:{"acl": "public-read" },

HTML中:<input type="text" name="acl" value="public-read" />

x-obs-grant-read

创建对象时,使用此头域授权domain下所有用户有读对象和获取对象元数据的权限。

类型:字符串。

示例:

POLICY中:{"grant-read": "id=domainId1" },

HTML中:<input type="text" name="grant-read" value="id=domainId1" />

x-obs-grant-read-acp

创建对象时,使用此头域授权domain下所有用户有获取对象ACL的权限。

类型:字符串。

示例:

POLICY中:{"grant-read-acp": "id=domainId1" },

HTML中:<input type="text" name="grant-read-acp" value="id=domainId1" />

x-obs-grant-write-acp

创建对象时,使用此头域授权domain下所有用户有写对象ACL的权限。

类型:字符串。

示例:

POLICY中:{"grant-write-acp": "id=domainId1" },

HTML中:<input type="text" name="grant-write-acp" value="id=domainId1" />

x-obs-grant-full-control

创建对象时,使用此头域授权domain下所有用户有读对象、获取对象元数据、获取对象ACL、写对象ACL的权限。

类型:字符串。

示例:

POLICY中:{"grant-full-control": "id=domainId1" },

HTML中:<input type="text" name="grant-full-control" value="id=domainId1" />

x-obs-storage-class

创建对象时,可以加上此头域设置对象的存储类型。如果未设置此头域,则以桶的默认存储类型作为对象的存储类型。

类型:字符串

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

示例:

POLICY中:{"storage-class": "STANDARD" },

HTML中:<input type="text" name="x-obs-storage-class" value="STANDARD" />

Cache-Control,

Content-Type,

Content-Disposition,

Content-Encoding

Expires

这5个参数是HTTP标准消息头,OBS将这些参数记录下来,当用户下载此对象或Head Object时,在响应消息头中携带这些参数。

类型:字符串。

示例:

POLICY中:["starts-with", "$Content-Type", "text/"],

HTML中:<input type="text" name="content-type" value="text/plain" />

success_action_redirect

此参数的值是一个URL,用于指定当此次请求操作成功响应后的重定向的地址。

  • 如果此参数值有效且操作成功,响应码为303,Location头域由此参数以及桶名、对象名、对象的ETag组成。
  • 如果此参数值无效,则OBS忽略此参数的作用,响应码为204,Location头域为对象地址。

类型:字符串。

示例:

POLICY中:{"success_action_redirect": "http://123458.com"},

HTML中:<input type="text" name="success_action_redirect" value="http://123458.com" />

x-obs-meta-*

创建对象时,可以在HTTP请求中加入“x-obs-meta-”消息头或以“x-obs-meta-”开头的消息头,用来加入自定义的元数据,以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时,加入的自定义元数据将会在返回消息的消息头中出现。

类型:字符串。

示例:

POLICY中:{" x-obs-meta-test ": " test metadata " },

HTML中:<input type="text" name=" x-obs-meta-test " value=" test metadata " />

success_action_status

这个参数指定成功响应的状态码,允许设定的值为200,201,204。

  • 如果此参数值被设定为200或204,OBS响应消息中body为空。
  • 如果此参数值被设定为201,则OBS响应消息中包含一个XML文档描述此次请求的响应。
  • 当请求不协带此参数或参数无效时,OBS响应码为204。

类型:字符串。

示例:

POLICY中:["starts-with", "$success_action_status", ""],

HTML中:<input type="text" name="success_action_status" value="200" />

x-obs-website-redirect-location

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

默认值:无

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

x-obs-server-side-encryption

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

类型:字符串

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

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

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

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

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

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

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

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

类型:整型。

示例:x-obs-expires:3

响应消息样式

1
2
3
4
5
HTTP/1.1 status_code
Content-Type: application/xml 
Location: location
Date: date
ETag: etag

响应消息头

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

除公共响应消息头之外,还可能使用如表3中的消息头。

表3 附加响应消息头

消息头名称

描述

x-obs-version-id

对象的版本号。如果桶的多版本状态为开启,则会返回对象的版本号。如果桶的多版本状态为暂停,则会返回null

类型:字符串

Access-Control-Allow-Origin

当桶设置了CORS配置,如果请求的Origin满足服务端的CORS配置,则在响应中包含这个Origin。

类型:字符串

Access-Control-Allow-Headers

当桶设置了CORS配置,如果请求的headers满足服务端的CORS配置,则在响应中包含这个headers。

类型:字符串

Access-Control-Max-Age

当桶设置了CORS配置,服务端CORS配置中的MaxAgeSeconds。

类型:整数

Access-Control-Allow-Methods

当桶设置了CORS配置,如果请求的Access-Control-Request-Method满足服务端的CORS配置,则在响应中包含这条rule中的Methods。

类型:字符串

有效值:GET、PUT、HEAD、POST 、DELETE

Access-Control-Expose-Headers

当桶设置了CORS配置,服务端CORS配置中的ExposeHeader。

类型:字符串

x-obs-server-side-encryption

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

类型:字符串

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

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

如果服务端加密是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

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

类型:字符串

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

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

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

类型:字符串

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

响应消息元素

该请求的响应消息中不带消息元素。

错误响应消息

无特殊错误,所有错误已经包含在表2中。

请求示例1

普通POST上传

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
POST / HTTP/1.1
Date: WED, 01 Jul 2015 04:15:23 GMT
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Content-Type: multipart/form-data; boundary=7db143f50da2
Content-Length: 2424
Origin: www.example.com
Access-Control-Request-Headers:acc_header_1

--7db143f50da2
Content-Disposition: form-data; name="key"

object01
--7db143f50da2
Content-Disposition: form-data; name="acl"

public-read
--7db143f50da2 
Content-Disposition: form-data; name="content-type"

text/plain
--7db143f50da2
Content-Disposition: form-data; name="expires"

WED, 01 Jul 2015 04:16:15 GMT
--7db143f50da2
Content-Disposition: form-data; name="AccessKeyId"

14RZT432N80TGDF2Y2G2
--7db143f50da2
Content-Disposition: form-data; name="policy"

ew0KICAiZXhwaXJhdGlvbiI6ICIyMDE1LTA3LTAxVDEyOjAwOjAwLjAwMFoiLA0KICAiY29uZGl0aW9ucyI6IFsNCiAgICB7ImJ1Y2tldCI6ICJleG1hcGxlYnVja2V0IiB9LA0KICAgIHsiYWNsIjogInB1YmxpYy1yZWFkIiB9LA0KICAgIHsiRXhwaXJlcyI6ICIxMDAwIiB9LA0KICAgIFsiZXEiLCAiJGtleSIsICJvYmplY3QwMSJdLA0KICAgIFsic3RhcnRzLXdpdGgiLCAiJENvbnRlbnQtVHlwZSIsICJ0ZXh0LyJdLA0KICBdDQp9DQo=
--7db143f50da2
Content-Disposition: form-data; name="signature"

Vk6rwO0Nq09BLhvNSIYwSJTRQ+k=
--7db143f50da2
Content-Disposition: form-data; name="file"; filename="C:\Testtools\UpLoadFiles\object\1024Bytes.txt"
Content-Type: text/plain

01234567890
--7db143f50da2
Content-Disposition: form-data; name="submit"

Upload
--7db143f50da2--

响应示例1

桶配置cors后,响应会包含Access-Control-*的信息。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
HTTP/1.1 204 No Content
x-obs-request-id: 90E2BA00C26C00000133B442A90063FD
x-obs-id-2: OTBFMkJBMDBDMjZDMDAwMDAxMzNCNDQyQTkwMDYzRkRBQUFBQUFBQWJiYmJiYmJi
Access-Control-Allow-Origin: www.example.com
Access-Control-Allow-Methods: POST,GET,HEAD,PUT
Access-Control-Allow-Headers: acc_header_01
Access-Control-Max-Age: 100
Access-Control-Expose-Headers: exp_header_01
Content-Type: text/xml
Location: http://examplebucket.obs.cn-north-4.myhuaweicloud.com/object01
Date: WED, 01 Jul 2015 04:15:23 GMT
ETag: "ab7abb0da4bca5323ab6119bb5dcd296"

请求示例2

带x-obs-acl头域并指定存储类型,重定向头域,上传对象

编码前,policy的内容为

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
    "expiration":"2018-07-17T04:54:35Z",
    "conditions":[
        {
            "content-type":"text/plain"
        },
        {
            "x-obs-storage-class":"WARM"
        },
        {
            "success_action_redirect":"http://www.example.com"
        },
        {
            "x-obs-acl":"public-read"
        },
        [
            "starts-with",
            "$bucket",
            ""
        ],
        [
            "starts-with",
            "$key",
            ""
        ]
    ]
}

请求示例:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
POST / HTTP/1.1
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Accept-Encoding: identity
Content-Length: 947
Content-Type: multipart/form-data; boundary=9431149156168
User-Agent: OBS/Test

--9431149156168
Content-Disposition: form-data; name="x-obs-acl"

public-read
--9431149156168
Content-Disposition: form-data; name="AccessKeyId"

H4IPJX0TQTHTHEBQQCEC
--9431149156168
Content-Disposition: form-data; name="key"

my-obs-object-key-demo
--9431149156168
Content-Disposition: form-data; name="signature"

WNwv8P1ZiWdqPQqjXeLmAfzPDAI=
--9431149156168
Content-Disposition: form-data; name="policy"

eyJleHBpcmF0aW9uIjoiMjAxOC0wNy0xN1QwODozNDoyM1oiLCAiY29uZGl0aW9ucyI6W3siY29udGVudC10eXBlIjoidGV4dC9wbGFpbiJ9LHsieC1vYnMtYWNsIjoicHVibGljLXJlYWQifSxbInN0YXJ0cy13aXRoIiwgIiRidWNrZXQiLCAiIl0sWyJzdGFydHMtd2l0aCIsICIka2V5IiwgIiJdXX0=
--9431149156168
Content-Disposition: form-data; name="content-type"

text/plain
--9431149156168
Content-Disposition: form-data; name="file"; filename="myfile"
Content-Type: text/plain

c2c6cd0f-898e-11e8-aab6-e567c91fb541
52b8e8a0-8481-4696-96f3-910635215a78

--9431149156168--

响应示例2

1
2
3
4
5
6
7
HTTP/1.1 204 No Content
Server: OBS
Location: http://examplebucket.obs.cn-north-4.myhuaweicloud.com/my-obs-object-key-demo
ETag: "17a83fc8d431273405bd266114b7e034"
x-obs-request-id: 5DEB00000164A728A7C7F4E032214CFA
x-obs-id-2: 32AAAUJAIAABAAAQAAEAABAAAQAAEAABCSwj2PcBE0YcoLHUDO7GSj+rVByzjflA
Date: Tue, 17 Jul 2018 07:33:36 GMT

本站部分内容转载于网络,版权归原作者所有,转载之目的在于传播更多优秀技术内容,如有侵权请联系QQ/微信:153890879删除,谢谢!

推荐图文

  • 周排行
  • 月排行
  • 总排行

随机推荐