追加写对象

append

String

是

参数解释：

表明这是以追加写方式上传对象。

约束限制：

无

取值范围：

无

默认取值：

无

position

Integer

是

参数解释：

追加写位置。

约束限制：

不能超过5GB。

取值范围：

需要追加写的对象首次上传时就必须指定position为0，下次追加需要填写的position会在服务端本次上传成功返回消息的头域x-obs-next-append-position中携带。

默认取值：

无

x-obs-acl

String

否

参数解释：

第一次写时，可以加上此消息头设置对象的权限控制策略，使用的策略为预定义的常用策略。

约束限制：

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

取值范围：

• 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

否

参数解释：

第一次写时，使用此头域授权读对象、获取对象元数据、获取对象ACL、写对象ACL的权限给domain下的所有用户。

示例：x-obs-grant-full-control: id=domainID。

约束限制：

如果授权给多个租户，需要通过“,”分隔。

取值范围：

无

默认取值：

无

x-obs-storage-class

String

否

参数解释：

第一次写时，可以加上此头域设置对象的存储类型。

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

约束限制：

• 归档存储和深度归档存储对象不支持追加上传。
• 设置对象的存储类型时请注意大小写敏感。

取值范围：

• STANDARD
• WARM

默认取值：

如果未设置此头域，则以桶的默认存储类型作为对象的存储类型。

x-obs-meta-*

String

否

参数解释：

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

示例：x-obs-meta-test：test metadata

约束限制：

HTTP请求不包含消息体，长度不能超过8KB。

取值范围：

无

默认取值：

无

x-obs-persistent-headers

String

否

参数解释：

第一次写时，可以在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中返回。
• 如果value解码后存在非US-ASCII值或不可识别字符，则服务端只会作为字符串处理并通过“?UTF-8?B?<(str)>?=”包装，而不会做解码，例如key1:abbc，会返回key1: =?UTF-8?B?abbc?=。
• value不支持包含的字符“空格”、“=”、“,”、“;”、“:”、"."，如果需要包含，请使用URL编码或者Base64编码。

取值范围：

无

默认取值：

无

x-obs-website-redirect-location

String

否

参数解释：

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

约束限制：

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

取值范围：

无

默认取值：

无

x-obs-expires

Integer

否

参数解释：

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

示例：x-obs-expires：3

约束限制：

设置的天数计算出的过期时间不能早于当前时间，如10天前上传的对象，不能设置小于10的值。

取值范围：

大于0的整数值。

默认取值：

无

x-obs-tagging

String

否

参数解释：

以键值对（Key-Value）的形式指定对象的标签信息，可同时设置多个标签。

示例：x-obs-tagging:TagA=A&TagB&TagC

约束限制：

• 该请求头仅在首次追加操作时设置生效，后续追加操作不生效。
• Key或Value包含特殊字符以及“=”、中文字符时，需要进行URL编码处理。
• 如果某项没有“=”，则看作Value为空字符串。

取值范围：

无

默认取值：

无

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

否

参数解释：

在SSE-KMS加密方式下使用该头域，该头域表示对象使用的数据加密算法。

示例：x-obs-server-side-data-encryption：SM4

约束限制:

无

取值范围：

• 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方式时，必选。

参数解释：

在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一起使用。

取值范围：

AES256

默认取值：

无

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

String

否。当使用SSE-C方式时，必选。

参数解释：

在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一起使用。

取值范围：

无

默认取值：

无

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

String

否。当使用SSE-C方式时，必选。

参数解释：

在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一起使用。

取值范围：

密钥ID MD5的base64值。

默认取值：

无

x-obs-version-id

String

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无

x-obs-server-side-encryption

String

参数解释：

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

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

约束限制：

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

取值范围：

• kms
• AES256

默认取值：

无

x-obs-server-side-data-encryption

String

参数解释：

如果服务端加密是SSE-KMS方式，且数据加密算法为SM4，响应包含该头域。

示例：x-obs-server-side-data-encryption：SM4

约束限制：

无

取值范围：

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-MD5

String

参数解释：

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

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

约束限制：

无

取值范围：

密钥ID MD5的base64值。

默认取值：

无

x-obs-next-append-position

Integer

参数解释：

指明下一次请求应该提供的position。

约束限制：

对象为Appendable对象时，会返回此头域。

取值范围：

无

默认取值：

无