追加写对象AppendObject_对象操作_对象存储服务API-华为云

华为云计算云知识追加写对象AppendObject

普惠上云 2核2G2M云服务器

38元/年

云服务器新品 X实例-4核8G5M

288元/年

GeminiDB Redis 4GB 游戏广告

19元/年

网站搭建买3年送2年

1元/天

追加写对象AppendObject

时间: 2023-08-15 11:18:51

API网关云服务器云主机云计算弹性伸缩

猜你想看：

华为云耀L实例实时语音识别云服务器配置 CDN是什么意思视频点播加速什么是云桌面

接口说明

追加写对象操作是指在指定桶内的一个对象尾追加上传数据,不存在相同对象键值的对象则创建新对象。

通过Append Object操作创建的Object类型为Appendable Object,而通过Put Object上传的Object是Normal Object。

说明: 用户上传的对象存储在桶中。用户必须对桶有WRITE权限,才可以在桶中上传对象。同一个桶中存储的对象名必须是唯一的。

为了确保数据在传输过程中没有遭到破坏,用户可以在请求消息头中加入Content-MD5参数,OBS收到上传数据后,会对数据进行MD5校验,如果不一致则返回出错信息。

该操作支持在创建Appendable对象时指定x-obs-acl参数,设置对象的权限控制策略。

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

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	否	请求参数position=0时,该请求可以使用的附加消息头第一次写时,可以加上此消息头设置对象的权限控制策略,使用的策略为预定义的常用策略,包括:private;public-read;public-read-write(各策略详细说明见ACL章节的“使用头域设置ACL”)。类型:字符串说明:字符串形式的预定义策略。
x-obs-grant-read	string	header	否	请求参数position=0时,该请求可以使用的附加消息头第一次写时,使用此头域授权domain下所有用户有读对象和获取对象元数据的权限。
x-obs-grant-read-acp	string	header	否	请求参数position=0时,该请求可以使用的附加消息头第一次写时,使用此头域授权domain下所有用户有获取对象ACL的权限。
x-obs-grant-write-acp	string	header	否	请求参数position=0时,该请求可以使用的附加消息头第一次写时,使用此头域授权domain下所有用户有写对象ACL的权限。
x-obs-grant-full-control	string	header	否	请求参数position=0时,该请求可以使用的附加消息头第一次写时,使用此头域授权domain下所有用户有读对象、获取对象元数据、获取对象ACL、写对象ACL的权限。
x-obs-storage-class	string	header	否	请求参数position=0时,该请求可以使用的附加消息头第一次写时,可以加上此头域设置对象的存储类型。如果未设置此头域,则以桶的默认存储类型作为对象的存储类型。类型:字符串说明:虽然存储类型有3种:STANDARD(标准存储)、WARM(低频访问存储)、COLD(归档存储),但是冷对象不支持追加上传,这里可配置的值只能是:STANDARD和WARM,注意大小写敏感。示例:x-obs-storage-class:STANDA
x-obs-meta-*	string	header	否	请求参数position=0时,该请求可以使用的附加消息头第一次写时,可以在HTTP请求中加入以“x-obs-meta-”开头的消息头,用来加入自定义的元数据,以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时,加入的自定义元数据将会在返回消息的头中出现。HTTP请求不包含消息体,长度不能超过8KB。类型:字符串示例:x-obs-meta-test:test metadata
x-obs-persistent-headers	string	header	否	请求参数position=0时,该请求可以使用的附加消息头第一次写时,可以在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:dmFsdWUy 下载此对象或获取此对象元数据时:返回两个头域分别为“key1:value1”与“key2:value2” 约束: 通过该方式指定的自定义响应头不能以“x-obs-”为前缀,比如可以指定“key1”,但是不能指定“x-obs-key1” 不能指定http标准头,例如host/content-md5/origin/range/Content-Disposition等此头域和自定义元数据总长度不能超过8KB 如果传入相同key,将value以“,”拼接后放入同一个key中返回
x-obs-website-redirect-location	string	header	否	请求参数position=0时,该请求可以使用的附加消息头当桶设置了Website配置,可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL,OBS将这个值从头域中取出,保存在对象的元数据中。类型:字符串默认值:无约束:必须以“/”、“http://”或“https://”开头,长度不超过2K。
x-obs-expires	integer	header	否	请求参数position=0时,该请求可以使用的附加消息头表示对象的过期时间,单位是天。过期之后对象会被自动删除。(从对象最后修改时间开始计算)
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方式下使用该头域,该头域表示主密钥,如果用户没有提供该头域,那么默认的主密钥将会被使用。类型:字符串支持两种格式的描述方式: regionID:domainID(租户ID):key/key_id 或者 2.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-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+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	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方式时,必选。
object_key	string	path	是	追加写的对象名称。
bucket_name	string	query	是	请求的桶名称。
append	string	query	是	append表示以追加写方式上传对象。
position	integer	query	是	追加写位置。需要追加写的对象首次上传时就必须指定position为0,下次追加需要填写的position会在服务端本次上传成功返回消息的头域x-obs-next-append-position中携带。

Body参数

名称	类型	必选	描述
值	file	否

返回参数

返回码: 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-version-id	string	否	对象的版本号。如果桶的多版本状态为开启,则会返回对象的版本号。
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==
x-obs-next-append-position	integer	否	指明下一次请求应该提供的position。

返回码: 400

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

错误码	描述	HTTP状态码
AppendTooLarge	本次追加上传使对象长度超过对象长度限制。	400 Bad Request
OperationNotSupported	桶设置了跨区域复制配置,则不能调用该接口。	400 Bad Request

名称	类型	必选	描述
Code	string	否	错误响应消息体XML中错误响应对应的HTTP消息返回码,具体的错误码请参见错误码-表2。
Message	string	否	错误响应消息体XML中具体错误更全面、详细的英文解释,具体的错误消息请参见错误码-表2。
RequestId	string	否	本次错误请求的请求ID,用于错误定位。
HostId	string	否	返回该消息的服务端ID。
Resource	string	否	该错误相关的桶或对象资源。

返回码: 409

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

错误码	描述	HTTP状态码
PositionNotEqualToLength	position的值和当前对象的原始长度不一致	409 Bad Request
ObjectNotAppendable	指定桶中存在相同对象键值的对象,对象类型非Appendable。	409 Bad Request
ObjectNotAppendable	对象追加写次数超过10000次。	409 Bad Request
ObjectNotAppendable	对象存储类型为Cold,则不能调用该接口。	409 Bad Request

名称	类型	必选	描述
Code	string	否	错误响应消息体XML中错误响应对应的HTTP消息返回码,具体的错误码请参见错误码-表2。
Message	string	否	错误响应消息体XML中具体错误更全面、详细的英文解释,具体的错误消息请参见错误码-表2。
RequestId	string	否	本次错误请求的请求ID,用于错误定位。
HostId	string	否	返回该消息的服务端ID。
Resource	string	否	该错误相关的桶或对象资源。

请求示例

示例 1

"/obj001?append&position=0"

"POST /obj001?append&position=0 HTTP/1.1\nHost: examplebucket.obs.cn-north-4.myhuaweicloud.com\nExpires: Wed, 27 Jun 2015 13:45:50 GMT\nDate: Wed, 08 Jul 2015 06:57:01 GMT\nx-obs-website-redirect-location: http://www.example.com/\nx-obs-meta-redirect: redirect\nContent-Length: 6\nAuthorization: OBS H4IPJX0TQTHTHEBQQCEC:kZoYNv66bsmc10+dcGKw5x2PRrk=\n\n[6 bytes of object data]\n"

错误码

请参考错误码说明。