初始化上传段任务

uploads

String

是

参数解释：

表明这是多段上传任务。

约束限制：

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

取值范围：

取值为空。

默认取值：

无

encoding-type

String

否

参数解释：

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

约束限制:

无

取值范围：

URL

默认取值：

无，不设置则不编码。

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。

取值范围：

无

默认取值：

无

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值。

默认取值：

无

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

默认取值：

无，不设置则不编码。