PUT上传
功能介绍
用户在OBS系统中创建了桶之后,可以采用PUT操作的方式将对象上传到桶中。上传对象操作是指在指定的桶内增加一个对象,执行该操作需要用户拥有桶的写权限。
同一个桶中存储的对象名是唯一的。
在桶未开启多版本的情况下,如果在指定的桶内已经有相同的对象键值的对象,用户上传的新对象会覆盖原来的对象;为了确保数据在传输过程中没有遭到破坏,用户可以在请求消息头中加入Content-MD5参数。在这种情况下,OBS收到上传的对象后,会对对象进行MD5校验,如果不一致则返回出错信息。
用户还可以在上传对象时指定x-obs-acl参数,设置对象的权限控制策略。如果匿名用户在上传对象时未指定x-obs-acl参数,则该对象默认可以被所有OBS用户访问。
该操作支持服务端加密功能。
单次上传对象大小范围是[0, 5GB],如果需要上传超过5GB的大文件,需要通过多段操作来分段上传。
OBS没有文件夹的概念。为了使用户更方便进行管理数据,OBS提供了一种方式模拟文件夹:通过在对象的名称中增加“/”,例如“test/123.jpg”。此时,“test”就被模拟成了一个文件夹,“123.jpg”则模拟成“test”文件夹下的文件名了,而实际上,对象名称(Key)仍然是“test/123.jpg”。此类命名方式的对象,在控制台上会以文件夹的形式展示。当您上传此类方式命名的对象时,如果其大小不为0,控制台上会展示为空文件夹,但是存储总用量为对象大小。
对象名中包含特殊字符时需要进行URL编码,例如:#obj需要编码为%23obj。
与POST上传的区别
PUT上传中参数通过请求头域传递;POST上传则作为消息体中的表单域传递。
PUT上传需在URL中指定对象名;POST上传提交的URL为桶域名,无需指定对象名。两者的请求行分别为:
PUT /ObjectName HTTP/1.1
POST / HTTP/1.1
使用PUT上传请求时,消息体中如果使用POST格式,则上传到OBS中的对象会以表单形式呈现。
关于POST上传的更多详细信息,请参考POST上传。
多版本
如果桶的多版本状态是开启的,系统会自动为对象生成一个唯一的版本号,并且会在响应报头x-obs-version-id返回该版本号。如果桶的多版本状态是暂停的,则对象的版本号为null。关于桶的多版本状态,参见设置桶的多版本状态。
WORM
如果桶的WORM开关是开启的,则可以为对象配置WORM。您可以通过携带头域x-obs-object-lock-mode和x-obs-object-lock-retain-until-date在上传对象的同时指定对象的保护策略,如果您不携带这些头域,但配置了桶级默认WORM策略,则新上传的对象会自动应用默认策略。您还可以在上传后配置或修改对象级WORM保护策略。
在桶的WORM开关开启时,系统会自动打开多版本功能。WORM保护是基于对象版本号的,配置WORM的版本受到WORM保护,没有配置WORM的版本可正常删除。例如,test.txt 001受到WORM保护。此时再次上传同名文件,产生新的对象版本test.txt 002,test.txt 002并未配置WORM,那么test.txt 002就不受保护可以正常删除。当您下载对象时,不指定版本号下载的是最新对象,也就是test.txt 002。
请求消息样式
1 2 3 4 5 6 7 8 |
PUT /ObjectName HTTP/1.1 Host: bucketname.obs.cn-north-4.myhuaweicloud.com Content-Type: application/xml Content-Length: length Authorization: authorization Date: date <Optional Additional Header> <object Content> |
请求消息参数
该请求消息中不使用参数。
请求消息头
该请求使用公共的消息头,具体请参见表3。该请求可以使用附加的消息头,具体如表1所示。
OBS支持在上传对象时在请求里携带HTTP协议规定的6个请求头:Cache-Control、Expires、Content-Encoding、Content-Disposition、Content-Type、Content-Language。如果上传Object时设置了这些请求头,OBS会直接将这些头域的值保存下来。这6个值也可以通过OBS提供的修改对象元数据API接口进行修改。在该Object被下载或者HEAD的时候,这些保存的值将会被设置到对应的HTTP头域中返回客户端。
消息头名称 |
消息头类型 |
是否必选 |
描述 |
---|---|---|---|
Content-MD5 |
String |
否 |
参数解释: 按照RFC 1864标准计算出消息体的MD5摘要字符串,即消息体128-bit MD5值经过base64编码后得到的字符串。 示例:n58IG6hfM7vqI4K0vnWpog==。 约束限制: 无 取值范围: 无 默认取值: 无 |
x-obs-acl |
String |
否 |
参数解释: 创建对象时,可以加上此消息头设置对象的权限控制策略,使用的策略为预定义的常用策略。 约束限制: 预定义策略需要以字符串形式呈现。 取值范围:
各策略详细说明见ACL章节的“使用头域设置ACL”。 默认取值: private |
x-obs-grant-read |
String |
否 |
参数解释: 创建对象时,使用此头域授权租户下所有用户有读对象和获取对象元数据的权限。 示例:x-obs-grant-read: id=domainID。 约束限制: 如果授权给多个租户,需要通过“,”分隔。 取值范围: 需要为正确的租户ID,获取方式请参考获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 默认取值: 无 |
x-obs-grant-read-acp |
String |
否 |
参数解释: 创建对象时,使用此头域授权租户下所有用户有获取对象ACL的权限。 示例:x-obs-grant-read-acp: id=domainID。 约束限制: 如果授权给多个租户,需要通过“,”分隔。 取值范围: 需要为正确的租户ID,获取方式请参考获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 默认取值: 无 |
x-obs-grant-write-acp |
String |
否 |
参数解释: 创建对象时,使用此头域授权domain下所有用户有写对象ACL的权限。 示例:x-obs-grant-write-acp: id=domainID。 约束限制: 如果授权给多个租户,需要通过“,”分隔。 取值范围: 需要为正确的租户ID,获取方式请参考获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 默认取值: 无 |
x-obs-grant-full-control |
String |
否 |
参数解释: 创建对象时,使用此头域授权domain下所有用户有读对象、获取对象元数据、获取对象ACL、写对象ACL的权限。 示例:x-obs-grant-full-control: id=domainID。 约束限制: 如果授权给多个租户,需要通过“,”分隔。 取值范围: 需要为正确的租户ID,获取方式请参考获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 默认取值: 无 |
x-obs-storage-class |
String |
否 |
参数解释: 创建对象时,可以加上此头域设置对象的存储类型。如果未设置此头域,则以桶的默认存储类型作为对象的存储类型。 示例:x-obs-storage-class: STANDARD 约束限制: 设置该参数的值时请注意大小写敏感。 取值范围:
默认取值: 默认继承桶的存储类型。 |
x-obs-meta-* |
String |
否 |
参数解释: 创建对象时,可以在HTTP请求中加入以“x-obs-meta-”开头的消息头,用来加入自定义的元数据,以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时,加入的自定义元数据将会在返回消息的头中出现。更多说明详见对象自定义元数据介绍。 示例:x-obs-meta-test: test metadata 约束限制: 自定义元数据key-value对都必须符合US-ASCII。 取值范围: 无 默认取值: 无 |
x-obs-persistent-headers |
String |
否 |
参数解释: 创建对象时,可以在HTTP请求中加入“x-obs-persistent-headers”消息头,用来加入一个或多个自定义的响应头,当用户获取此对象或查询此对象元数据时,加入的自定义响应头将会在返回消息的头域中出现。 约束限制:
取值范围: 无 默认取值: 无 |
x-obs-website-redirect-location |
String |
否 |
参数解释: 当桶设置了Website配置,可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL,OBS将这个值从头域中取出,保存在对象的元数据中。 例如,重定向请求到桶内另一对象: x-obs-website-redirect-location:/anotherPage.html 或重定向请求到一个外部URL: x-obs-website-redirect-location:http://www.example.com/ 约束限制: 必须以“/”、“http://”或“https://”开头,长度不超过2KB。 取值范围: 无 默认取值: 无 |
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:国密SM4算法。 默认取值: 无 |
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== 约束限制:
取值范围: 密钥的MD5值。 默认取值: 无 |
success-action-redirect |
String |
否 |
参数解释: 用于指定当此次请求操作成功响应后的重定向的地址。
约束限制: 需要为URL格式,如http://domainname、https://domainname。 取值范围: URL 默认取值: 无 |
x-obs-expires |
Integer |
否 |
参数解释: 表示对象的过期时间,单位是天。过期之后对象会被自动删除。(从对象创建时间开始计算) 此字段对于每个对象支持上传时配置,也支持后期通过修改元数据接口修改。 示例:x-obs-expires:3 约束限制: 设置的天数计算出的过期时间不能早于当前时间,如10天前上传的对象,不能设置小于10的值。 取值范围: 大于0的整数值。 默认取值: 无 |
x-obs-tagging |
String |
否 |
参数解释: 以键值对(Key-Value)的形式指定Object的标签信息,可同时设置多个标签。 示例:x-obs-tagging:TagA=A&TagB&TagC 约束限制:
取值范围: 无 默认取值: 无 |
x-obs-object-lock-mode |
String |
否,携带x-obs-object-lock-retain-until-date头域时必带 |
参数解释: 要应用于此对象的WORM模式。 示例:x-obs-object-lock-mode:COMPLIANCE 约束限制:
取值范围: 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 约束限制:
取值范围: 需要大于当前时间。 默认取值: 无 |
请求消息元素
该请求消息中不使用消息元素,在消息体中带的是对象的数据。
响应消息样式
1 2 3 |
HTTP/1.1 status_code Content-Length: length Content-Type: type |
响应消息头
该请求的响应消息使用公共消息头,具体请参考表1。
除公共响应消息头之外,还可能使用如表2中的消息头。
消息头名称 |
消息头类型 |
描述 |
---|---|---|
x-obs-version-id |
String |
参数解释: 对象的版本号。如果桶的多版本状态为开启,则会返回对象的版本号。 约束限制: 无 取值范围: 无 默认取值: 无 |
x-obs-server-side-encryption |
String |
参数解释: 该头域表示服务端的加密方式。 示例:x-obs-server-side-encryption:kms 约束限制: 如果服务端加密是SSE-KMS方式,响应包含该头域。 取值范围:
默认取值: 无 |
x-obs-server-side-data-encryption |
String |
参数解释: 如果服务端加密是SSE-KMS方式,且数据加密算法为SM4,响应包含该头域。 示例:x-obs-server-side-data-encryption:SM4 约束限制: 仅在SSE-KMS加密方式下使用该头域。 取值范围: SM4:国密SM4算法 默认取值: 无 |
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方式,响应包含该头域。 取值范围: 密钥的MD5值。 默认取值: 无 |
x-obs-storage-class |
String |
参数解释: 对象的存储类别。 约束限制: 对象为非标准存储对象时,会返回此头域。 取值范围:
默认取值: 无 |
响应消息元素
该请求的响应消息不带消息元素。
错误响应消息
该请求的返回无特殊错误,所有错误已经包含在表2中。
请求示例:上传对象
1 2 3 4 5 6 7 8 9 10 |
PUT /object01 HTTP/1.1 User-Agent: curl/7.29.0 Host: examplebucket.obs.cn-north-4.myhuaweicloud.com Accept: */* Date: WED, 01 Jul 2015 04:11:15 GMT Authorization: OBS H4IPJX0TQTHTHEBQQCEC:gYqplLq30dEX7GMi2qFWyjdFsyw= Content-Length: 10240 Expect: 100-continue [1024 Byte data content] |
响应示例:上传对象
1 2 3 4 5 6 7 |
HTTP/1.1 200 OK Server: OBS x-obs-request-id: BF2600000164364C10805D385E1E3C67 ETag: "d41d8cd98f00b204e9800998ecf8427e" x-obs-id-2: 32AAAWJAMAABAAAQAAEAABAAAQAAEAABCTzu4Jp2lquWuXsjnLyPPiT3cfGhqPoY Date: WED, 01 Jul 2015 04:11:15 GMT Content-Length: 0 |
请求示例:上传对象的同时设置ACL
1 2 3 4 5 6 7 8 9 10 11 |
PUT /object01 HTTP/1.1 User-Agent: curl/7.29.0 Host: examplebucket.obs.cn-north-4.myhuaweicloud.com Accept: */* Date: WED, 01 Jul 2015 04:13:55 GMT x-obs-grant-read:id=52f24s3593as5730ea4f722483579ai7,id=a93fcas852f24s3596ea8366794f7224 Authorization: OBS H4IPJX0TQTHTHEBQQCEC:gYqplLq30dEX7GMi2qFWyjdFsyw= Content-Length: 10240 Expect: 100-continue [1024 Byte data content] |
响应示例:上传对象的同时设置ACL
1 2 3 4 5 6 7 |
HTTP/1.1 200 OK Server: OBS x-obs-request-id: BB7800000164845759E4F3B39ABEE55E ETag: "d41d8cd98f00b204e9800998ecf8427e" x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSReVRNuas0knI+Y96iXrZA7BLUgj06Z Date: WED, 01 Jul 2015 04:13:55 GMT Content-Length: 0 |
请求示例:桶开启多版本时上传对象
1 2 3 4 5 6 7 8 9 10 11 |
PUT /object01 HTTP/1.1 User-Agent: curl/7.29.0 Host: examplebucket.obs.cn-north-4.myhuaweicloud.com Accept: */* Date: WED, 01 Jul 2015 04:17:12 GMT x-obs-storage-class: WARM Authorization: OBS H4IPJX0TQTHTHEBQQCEC:uFVJhp/dJqj/CJIVLrSZ0gpw3ng= Content-Length: 10240 Expect: 100-continue [1024 Byte data content] |
响应示例:桶开启多版本时上传对象
1 2 3 4 5 6 7 8 |
HTTP/1.1 200 OK Server: OBS x-obs-request-id: DCD2FC9CAB78000001439A51DB2B2577 ETag: "d41d8cd98f00b204e9800998ecf8427e" X-OBS-ID-2: GcVgfeOJHx8JZHTHrRqkPsbKdB583fYbr3RBbHT6mMrBstReVILBZbMAdLiBYy1l Date: WED, 01 Jul 2015 04:17:12 GMT x-obs-version-id: AAABQ4q2M9_c0vycq3gAAAAAVURTRkha Content-Length: 0 |
请求示例:上传对象时携带MD5
1 2 3 4 5 6 7 8 9 10 11 |
PUT /object01 HTTP/1.1 User-Agent: curl/7.29.0 Host: examplebucket.obs.cn-north-4.myhuaweicloud.com Accept: */* Date: WED, 01 Jul 2015 04:17:50 GMT Authorization: OBS H4IPJX0TQTHTHEBQQCEC:uFVJhp/dJqj/CJIVLrSZ0gpw3ng= Content-Length: 10 Content-MD5: 6Afx/PgtEy+bsBjKZzihnw== Expect: 100-continue 1234567890 |
响应示例:上传对象时携带MD5
1 2 3 4 5 6 7 |
HTTP/1.1 200 OK Server: OBS x-obs-request-id: BB7800000164B165971F91D82217D105 X-OBS-ID-2: 32AAAUJAIAABAAAQAAEAABAAAQAAEAABCSEKhBpS4BB3dSMNqMtuNxQDD9XvOw5h ETag: "1072e1b96b47d7ec859710068aa70d57" Date: WED, 01 Jul 2015 04:17:50 GMT Content-Length: 0 |
请求示例:上传时配置website实现下载对象重定向
当桶设置了Website配置,您可以在上传对象时进行以下设置,设置后用户在下载对象时会重定向
1 2 3 4 5 6 7 8 9 10 11 |
PUT /object01 HTTP/1.1 User-Agent: curl/7.29.0 Host: examplebucket.obs.cn-north-4.myhuaweicloud.com Accept: */* Date: WED, 01 Jul 2015 04:17:12 GMT x-obs-website-redirect-location: http://www.example.com/ Authorization: OBS H4IPJX0TQTHTHEBQQCEC:uFVJhp/dJqj/CJIVLrSZ0gpw3ng= Content-Length: 10240 Expect: 100-continue [1024 Byte data content] |
响应示例:上传时配置website实现下载对象重定向
1 2 3 4 5 6 7 8 |
HTTP/1.1 200 OK Server: OBS x-obs-request-id: DCD2FC9CAB78000001439A51DB2B2577 x-obs-id-2: 32AAAUJAIAABAAAQAAEAABAAAQAAEAABCTmxB5ufMj/7/GzP8TFwTbp33u0xhn2Z ETag: "1072e1b96b47d7ec859710068aa70d57" Date: WED, 01 Jul 2015 04:17:12 GMT x-obs-version-id: AAABQ4q2M9_c0vycq3gAAAAAVURTRkha Content-Length: 0 |
请求示例:在URL中携带签名并上传对象
PUT /object02?AccessKeyId=H4IPJX0TQTHTHEBQQCEC&Expires=1532688887&Signature=EQmDuOhaLUrzrzRNZxwS72CXeXM%3D HTTP/1.1 User-Agent: curl/7.29.0 Host: examplebucket.obs.cn-north-4.myhuaweicloud.com Accept: */* Content-Length: 1024 [1024 Byte data content]
响应示例:在URL中携带签名并上传对象
1 2 3 4 5 6 7 8 |
HTTP/1.1 200 OK Server: OBS x-obs-request-id: DCD2FC9CAB78000001439A51DB2B2577 x-obs-id-2: 32AAAUJAIAABAAAQAAEAABAAAQAAEAABCTmxB5ufMj/7/GzP8TFwTbp33u0xhn2Z ETag: "1072e1b96b47d7ec859710068aa70d57" Date: Fri, 27 Jul 2018 10:52:31 GMT x-obs-version-id: AAABQ4q2M9_c0vycq3gAAAAAVURTRkha Content-Length: 0 |
请求示例:上传指定存储类型的对象
1 2 3 4 5 6 7 8 9 10 11 |
PUT /object01 HTTP/1.1 User-Agent: curl/7.29.0 Host: examplebucket.obs.cn-north-4.myhuaweicloud.com Accept: */* Date: WED, 01 Jul 2015 04:15:07 GMT x-obs-storage-class: WARM Authorization: OBS H4IPJX0TQTHTHEBQQCEC:uFVJhp/dJqj/CJIVLrSZ0gpw3ng= Content-Length: 10240 Expect: 100-continue [1024 Byte data content] |
响应示例:上传指定存储类型的对象
1 2 3 4 5 6 7 |
HTTP/1.1 200 OK Server: OBS x-obs-request-id: BB7800000164846A2112F98BF970AA7E ETag: "d41d8cd98f00b204e9800998ecf8427e" x-obs-id-2: a39E0UgAIAABAAAQAAEAABAAAQAAEAABCTPOUJu5XlNyU32fvKjM/92MQZK2gtoB Date: WED, 01 Jul 2015 04:15:07 GMT Content-Length: 0 |
请求示例:上传时配置对象级WORM保护策略
PUT /object01 HTTP/1.1 User-Agent: curl/7.29.0 Host: examplebucket.obs.cn-north-4.myhuaweicloud.com Accept: */* Date: WED, 01 Jul 2015 04:11:15 GMT Authorization: OBS H4IPJX0TQTHTHEBQQCEC:gYqplLq30dEX7GMi2qFWyjdFsyw= Content-Length: 10240 x-obs-object-lock-mode:COMPLIANCE x-obs-object-lock-retain-until-date:2022-09-24T16:10:25Z Expect: 100-continue [1024 Byte data content]
响应示例 :上传时配置对象级WORM保护策略
1 2 3 4 5 6 7 |
HTTP/1.1 200 OK Server: OBS x-obs-request-id: BF2600000164364C10805D385E1E3C67 ETag: "d41d8cd98f00b204e9800998ecf8427e" x-obs-id-2: 32AAAWJAMAABAAAQAAEAABAAAQAAEAABCTzu4Jp2lquWuXsjnLyPPiT3cfGhqPoY Date: WED, 01 Jul 2015 04:11:15 GMT Content-Length: 0 |