# 初始化上传段任务-InitiateMultipartUpload
#### 功能介绍
使用多段上传特性时，须先调用初始化上传段任务接口创建任务，系统会给用户返回一个全局唯一的多段上传任务号，作为任务标识。后续可以根据这个标识发起相关的请求，如：上传段、合并段、列举段等，了解完整的多段上传流程请参见[多段上传](https://support.huaweicloud.com/usermanual-obs/obs_41_0021.html)。创建多段上传任务不影响已有的同名对象；同一个对象可以同时存在多个多段上传任务；每个多段上传任务在初始化时可以附加消息头信息，包括acl、用户自定义元数据和通用的HTTP消息头contentType、contentEncoding等，这些附加的消息头信息将先记录在多段上传任务元数据中。
#### WORM
如果桶的WORM开关是开启的，则可以在初始化多段任务时配置对象级WORM保护策略。您可以通过携带头域x-obs-object-lock-mode和x-obs-object-lock-retain-until-date在初始化多段任务的同时指定最终合并对象的保护策略，如果您不携带这些头域，但配置了桶级默认WORM策略，则合并后的对象会自动应用默认策略。您还可以在合并后配置或修改对象级WORM保护策略。
与使用PUT和POST方法上传对象不同，多段上传对x-obs-object-lock-retain-until-date头域的约束只需要您提供不晚于初始化时间的日期，而无需晚于合并多段任务的时间。应用桶级默认WORM策略时，保护的起始时间从合并时间开始计算，即合并时间+桶级默认保护期限。在合并前，多段上传任务可以被取消，不会受到WORM功能影响。
#### 授权信息
您必须是桶拥有者或拥有初始化上传段任务的权限，才能调用本接口，建议使用IAM或桶策略进行授权。了解更多OBS授权方式请参见[OBS不同权限控制方式的区别](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)。
- 如果使用**IAM授权** ，那么请在"角色与策略授权"、"身份策略授权"两种IAM授权方式中选择一种，并配置相应权限：
- 如果使用**角色与策略授权** （旧版IAM，即IAM v3接口），需具备**obs:object:PutObject** 权限，授权操作请参见[创建IAM自定义策略](https://support.huaweicloud.com/usermanual-iam/iam_01_0605.html)。
- 如果使用**身份策略授权** （新版IAM，即IAM v5接口），如下表所示，需具备**obs:object:putObject** 权限，授权操作请参见[创建IAM自定义身份策略](https://support.huaweicloud.com/usermanual-iam5/iam_01_0917.html)。
| 授权项 Action | 访问级别 Access Level | 资源类型（\*为必须） Resource Type (\*: required) | [条件键](https://support.huaweicloud.com/api-obs/obs_04_0112.html#ZH-CN_TOPIC_0000002375307974__condition_table) Condition Key | [别名](https://support.huaweicloud.com/iam5_faq/iam_01_1103.html) Alias | 依赖的授权项 Dependencies |
|:---|:---|:---|:---|:---|:---|
| obs:object:putObject | Permission_management | object \* | [g:EnterpriseProjectId](https://support.huaweicloud.com/usermanual-iam5/iam_01_0934.html#section2) | - | - kms:cmk:create - kms:cmk:list - kms:cmk:createDataKey |
| obs:object:putObject | Permission_management | - | - obs:EpochTime - obs:SourceIp - obs:TlsVersion - obs:CustomDomain - obs:x-obs-acl | - | - kms:cmk:create - kms:cmk:list - kms:cmk:createDataKey |
- 如果使用**桶策略** 进行授权，需具备**obs:object:PutObject** 权限，具体操作请参见[自定义创建桶策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0123.html)。
#### URI
POST /{*object_key*}
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-obs/obs_04_0006.html)。调用前需要先[计算API签名](https://support.huaweicloud.com/api-obs/obs_04_0009.html)，并将签名添加到请求中。
您还可以使用[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/OBS/doc?api=InitiateMultipartUpload)在线调试接口。
#### 请求消息样式
```
POST /ObjectName?uploads HTTP/1.1
Host: bucketname.obs.cn-north-4.myhuaweicloud.com
Date: date
Authorization: authorization
```
#### URI参数（URI Parameters）
该请求需要在消息中指定参数，表明这是多段上传，参数意义如[表1]所示。
表1URI参数
| **参数名称** | **参数类型** | **是否必选** | **描述** |
|:---|:---|:---|:---|
| uploads | String | 是 | **参数解释：** 表明这是多段上传任务。 **约束限制：** - 该参数为空字符串。 - 如果请求未设置此参数，则为普通POST上传任务。 **取值范围：** 取值为空。 **默认取值：** 无 |
| encoding-type | String | 否 | **参数解释：** 用于指定对响应中的Key进行指定类型的编码。如果Key包含xml 1.0标准不支持的控制字符，可通过设置该参数对响应中的Key进行编码。 **约束限制:** 无 **取值范围：** URL **默认取值：** 无，不设置则不编码。 |
#### 请求头参数（Request headers）
该请求使用公共请求头，具体参见[表3](https://support.huaweicloud.com/api-obs/obs_04_0007.html#ZH-CN_TOPIC_0136436606__table25197309)。
除此之外，该请求可以使用附加的消息头，具体如[表2]所示。
表2请求头参数
| **消息头名称** | **消息头类型** | **是否必选** | **描述** |
|:---|:---|:---|:---|
| x-obs-acl | String | 否 | **参数解释：** 初始化多段上传任务时，可以加上此消息头设置对象的权限控制策略。 示例：x-obs-acl:public-read-write。 **约束限制：** 字符串形式的预定义策略。 **取值范围：** - private - public-read - public-read-write 各策略详细说明见[ACL](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0005.html)章节的"使用头域设置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：使用SSE-KMS加密方式 - AES256：使用SSE-OBS加密方式，且使用AES256算法 **默认取值：** 无 |
| x-obs-server-side-data-encryption | String | 否 | **参数解释：** 该头域表示对象使用的数据加密算法。 示例：x-obs-server-side-data-encryption: SM4 **约束限制：** 仅在SSE-KMS加密方式下使用该头域。 **取值范围：** - AES256：使用AES256算法 - SM4：使用SM4算法 **默认取值：** 无 |
| x-obs-server-side-encryption-kms-key-id | String | 否 | **参数描述：** 当加密方式为SSE-KMS且使用指定密钥加密时，需输入密钥ID。密钥ID获取方法请参见[查看密钥](https://support.huaweicloud.com/usermanual-dew/dew_01_0179.html)。 **约束限制：** 当您设置了x-obs-server-side-encryption头域且赋值为"kms"，即选择kms加密方式时，才能使用该头域指定加密密钥。 **默认取值：** 当您选择使用kms加密方式，但未设置此头域时，默认的主密钥将会被使用。如果默认主密钥不存在，系统将默认创建并使用。 |
| x-obs-server-side-encryption-bucket-key-enabled | String | 否 | **参数解释：** SSE-KMS桶密钥功能开关。 **约束限制：** 当您设置本头域为"true"时，必须同时设置本接口的另一个头域x-obs-server-side-encryption-kms-key-id以指定密钥ID。 **取值范围：** - true：开启桶密钥。 - false：关闭桶密钥。 **默认取值：** false |
| 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 | Data | 否，携带x-obs-object-lock-mode头域时必带 | **参数解释：** 对象的WORM策略过期的截止时间。需要大于当前时间。 示例：x-obs-object-lock-retain-until-date:2015-07-01T04:11:15.297Z **约束限制：** - 格式要求为UTC时间，并符合ISO 8601标准。如：2015-07-01T04:11:15.297Z。 - 该参数需要和x-obs-object-lock-mode一同使用。 |
| x-obs-meta-\* | String | 否 | **参数解释：** 初始化上传段任务时，可以在HTTP请求中加入以"x-obs-meta-"开头的消息头，用来加入自定义的元数据，以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时，加入的自定义元数据将会在返回消息的头中出现。更多说明详见[对象自定义元数据介绍](https://support.huaweicloud.com/usermanual-obs/obs_03_0324.html)。 示例：x-obs-meta-test: test metadata **约束限制：** HTTP请求不包含消息体，长度不能超过8KB。 **取值范围：** 无 **默认取值：** 无 |
其他公共消息头请参考[表3](https://support.huaweicloud.com/api-obs/obs_04_0007.html#ZH-CN_TOPIC_0136436606__table25197309)。
#### 请求体参数（Request body）
该请求消息中不带请求体参数。
#### 响应消息样式
```
HTTP/1.1 status_code
Date: date
Content-Length: length
Connection: status
BucketName
ObjectName
uploadID
```
#### 响应头 (Response Headers)
该请求的响应消息使用公共响应头，具体请参考[表1](https://support.huaweicloud.com/api-obs/obs_04_0013.html#ZH-CN_TOPIC_0173612084__d0e686)。
表3响应头
| **消息头名称** | **消息头类型** | **描述** |
|:---|:---|:---|
| x-obs-server-side-encryption | String | **参数解释：** 该头域表示服务端的加密方式。如果服务端加密是SSE-KMS方式，响应包含该头域。 示例：x-obs-server-side-encryption: kms **取值范围：** - kms：使用SSE-KMS加密方式 - AES256：使用SSE-OBS加密方式，且使用AES256算法 |
| x-obs-server-side-data-encryption | String | **参数解释：** 如果服务端加密是SSE-KMS方式，且数据加密算法为SM4，响应包含该头域。仅在SSE-KMS加密方式下使用该头域，如果开启SSE-KMS但不返回该头域则表明使用AES256算法。 示例：x-obs-server-side-data-encryption：SM4 **取值范围：** SM4：国密SM4算法 |
| x-obs-server-side-encryption-kms-key-id | String | **参数描述：** 当加密方式为SSE-KMS且使用指定密钥加密时，需输入密钥ID。密钥ID获取方法请参见[查看密钥](https://support.huaweicloud.com/usermanual-dew/dew_01_0179.html)。 **默认取值：** 不涉及。 |
| x-obs-sse-kms-key-project-id | String | **参数解释：** 加密方式为SSE-KMS且使用自定义KMS密钥加密时，返回KMS主密钥所属的项目ID（非企业项目ID）。 **取值范围：** x-obs-server-side-encryption-kms-key-id指定的KMS主密钥所属的项目ID（非企业项目ID）。 |
| 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 | **参数解释：** 该头域表示加密使用的密钥的MD5值。如果服务端加密是SSE-C方式，响应包含该头域。 示例：x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ== **取值范围：** 密钥ID MD5的base64值。 |
#### 响应体 (Response Body)
该请求响应消息中通过返回消息元素，返回本次多段上传任务的多段上传任务号、桶名、对象名，供后续上传段、合并段使用，元素的具体意义如[表4]所示。
表4响应体
| **元素名称** | **元素类型** | **描述** |
|:---|:---|:---|
| InitiateMultipartUploadResult | XML | **参数解释：** 描述多段上传任务的容器。 |
| Bucket | String | **参数解释** **：** 多段上传任务的桶名。桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **取值范围：** 无 |
| Key | String | **参数解释：** 多段上传任务的对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。了解对象更新信息请参见[对象概述](https://support.huaweicloud.com/usermanual-obs/obs_41_0015.html)。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 **取值范围：** 长度大于0且不超过1024的字符。 |
| UploadId | String | **参数解释：** 多段上传任务的ID，后面进行多段上传时，可利用这个ID指定多段上传任务。 **取值范围：** 长度大于0且不超过32的字符串。 |
| EncodingType | String | **参数解释：** 多段上传对象名的编码类型。如果请求中设置了encoding-type，那响应中的Key会被编码。不设置则不编码。 **取值范围：** URL |
#### 错误响应消息
1. 如果AccessKey或签名无效，OBS返回403 Forbidden，错误码为AccessDenied。
2. 如果桶不存在，OBS返回404 Not Found，错误码为NoSuchBucket。
3. 检查用户是否具有指定桶的写权限，如果没有权限，OBS返回403 Forbidden，错误码为AccessDenied。
其他错误已包含在[错误码概述](https://support.huaweicloud.com/api-obs/obs_04_0115.html)中。
#### 请求示例：初始化段
```
POST /objectkey?uploads HTTP/1.1
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Date: Wed, 01 Jul 2015 05:14:52 GMT
Authorization: OBS AKIAIOSFODNN7EXAMPLE:VGhpcyBtZXNzYWdlIHNpZ25lZGGieSRlbHZpbmc=
```
#### 响应示例：初始化段
```
HTTP/1.1 200 OK
Server: OBS
x-obs-id-2: Weag1LuByRx9e6j5Onimru9pO4ZVKnJ2Qz7/C1NPcfTWAtRPfTaOFg==
x-obs-request-id: 996c76696e6727732072657175657374
Date: Wed, 01 Jul 2015 05:14:52 GMT
Content-Length: 303
bucketname
objectkey
DCD2FC98B4F70000013DF578ACA318E7
```
#### 请求示例：初始化段的同时携带ACL
```
POST /objectkey?uploads HTTP/1.1
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Date: Wed, 01 Jul 2015 05:15:43 GMT
x-obs-grant-write-acp:ID=52f24s3593as5730ea4f722483579ai7,ID=a93fcas852f24s3596ea8366794f7224
Authorization: OBS AKIAIOSFODNN7EXAMPLE:VGhpcyBtZXNzYWdlIHNpZ25lZGGieSRlbHZpbmc=
```
#### 响应示例：初始化段的同时携带ACL
```
HTTP/1.1 200 OK
Server: OBS
x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAABCTnv+daB51p+IVhAvWN7s5rSKhcWqDFs
x-obs-request-id: BB78000001648457112DF37FDFADD7AD
Date: Wed, 01 Jul 2015 05:15:43 GMT
Content-Length: 303
bucketname
objectkey
000001648453845DBB78F2340DD460D8
```