文档首页/ 对象存储服务 OBS/ API参考/ API/ 多段操作/ 合并段
更新时间：2024-10-21 GMT+08:00
查看PDF
分享

合并段

功能介绍

如果用户上传完所有的段，就可以调用合并段接口，系统将在服务端将用户指定的段合并成一个完整的对象，了解完整的分段上传流程请参见分段上传。在执行“合并段”操作以前，用户不能下载已经上传的数据。在合并段时需要将多段上传任务初始化时记录的附加消息头信息拷贝到对象元数据中，其处理过程和普通上传对象带这些消息头的处理过程相同。在并发合并段的情况下，仍然遵循Last Write Win策略，但“Last Write”的时间定义为段任务的初始化时间。

已经上传的段，只要没有取消对应的多段上传任务，都要占用用户的容量配额；对应的多段上传任务“合并段”操作完成后，只有指定的多段数据占用容量配额，用户上传的其他此多段任务对应的段数据如果没有包含在“合并段”操作制定的段列表中，“合并段”完成后删除多余的段数据，且同时释放容量配额。

合并完成的多段上传数据可以通过已有的下载对象接口，下载整个多段上传对象或者指定Range下载整个多段上传对象的某部分数据。

合并完成的多段上传数据可以通过已有的删除对象接口，删除整个多段上传对象的所有分段数据，删除后不可恢复。

合并完成的多段上传数据不记录整个对象的MD5作为Etag，在下载多段数据或List桶内对象看到的多段数据其Etag的生成方式为：MD5（M1M2……MN）-N，其中，Mn表示第n段的MD5值， 如请求示例所示，有3个分段，每个分段都有对应的MD5值，合并段ETag的生成是先将3个分段的MD5合并起来再进行MD5计算得到一个新值，再拼接-N作为合并段的ETag值，-N表示总共有多少段，在该示例中即为-3。

合并段请求如果出现等待响应超时、服务端返回500或503报错时，建议客户端可以先尝试获取多段任务对应的对象元数据，并比较响应的x-obs-uploadId头域的值，是否与本次要合并的段任务ID相同，如果相同，说明服务端实际已经合并段成功，无需再进行重试。关于并发一致性说明，参见7.5-并发一致性说明。

WORM

如果桶的WORM开关是开启的，合并段会为合并后生成的对象自动应用WORM保护。如果您在初始化时指定了WORM相关头域并配置了保护截止日期，则会使用该日期作为合并生成对象的保护截止日期。如果您在初始化时没有指定WORM相关头域，但配置了桶级默认保护策略，则会自动应用桶级默认保护策略的保护期限，实际的保护截止日期为合并时间+保护期限。在您合并后，您依旧可以正常为合并后的对象配置对象级WORM保护策略。

多版本

如果桶的多版本状态是开启的，则合并段后得到的对象生成一个唯一的版本号，并且会在响应报头x-obs-version-id返回该版本号。如果桶的多版本状态是暂停的，则合并段后得到的对象版本号为null。关于桶的多版本状态，参见设置桶的多版本状态。

如果上传了10个段，但合并时只选择了9个段进行合并，那么未被合并的段将会被系统自动删除，未被合并的段删除后不能恢复。在进行合并之前请使用列出已上传的段接口进行查询，仔细核对所有段，确保没有段被遗漏。

请求消息样式

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
 
POST /ObjectName?uploadId=uploadID HTTP/1.1 
Host: bucketname.obs.cn-north-4.myhuaweicloud.com 
Date: date
Content-Length: length
Authorization: authorization
<CompleteMultipartUpload> 
    <Part> 
        <PartNumber>partNum</PartNumber> 
        <ETag>etag</ETag> 
    </Part> 
    <Part> 
        <PartNumber>partNum</PartNumber> 
        <ETag>etag</ETag> 
    </Part> 
    <Part> 
        <PartNumber>partNum</PartNumber> 
        <ETag>etag</ETag> 
    </Part> 
</CompleteMultipartUpload>

请求消息参数

该请求在消息参数中指定多段上传任务号来标明它要合并哪一个上传段任务，参数意义如表1所示。

表1 请求消息参数

参数名称

参数类型

是否必选

描述

uploadId

String

是

参数解释：

指明分段上传任务的ID。

取值范围：

长度为32的字符串。

默认取值：

无

encoding-type

String

否

参数解释：

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

约束限制：

无

取值范围：

URL

默认取值：

无，不设置则不编码。

请求消息头

该请求使用公共消息头，具体请参考表3。

请求消息元素

该请求需要在消息中带消息元素，指定要合并的段列表，元素的具体意义如表2中所示

表2 请求消息元素

元素名称

元素类型

是否必选

描述

CompleteMultipartUpload

XML

是

参数解释：

合并的段列表。

约束限制：

无

取值范围：

无

默认取值：

无

PartNumber

Integer

是

参数解释：

段号。

约束限制：

无

取值范围：

[1,10000]

默认取值：

无

ETag

String

是

参数解释：

上传段成功后返回的ETag值，是段内容的唯一标识。该值用于合并段时进行数据一致性校验。

约束限制：

无

取值范围：

长度为32的字符串。

默认取值：

无

响应消息样式

1
2
3
4
5
6
7
8
9
 
HTTP/1.1 status_code
Date: date
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> 
<CompleteMultipartUploadResult xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/"> 
    <Location>http://example-Bucket.obs.cn-north-4.myhuaweicloud.com/example-Object</Location> 
    <Bucket>bucketname</Bucket> 
    <Key>ObjectName</Key> 
    <ETag>ETag</ETag> 
</CompleteMultipartUploadResult>

响应消息头

该请求的响应消息使用公共消息头，具体请参考表1。

除公共响应消息头之外，还可能使用如表3中的消息头。

表3 附加响应消息头

消息头名称

消息头类型

描述

x-obs-version-id

String

参数解释：

合并得到的对象的版本号。

约束限制：

无

取值范围：

长度为32的字符串。

默认取值：

无

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

默认取值：

无

响应消息元素

该请求的响应消息中通过返回消息元素来返回合并段的结果，元素的具体意义如表4所示。

表4 响应消息元素

元素名称

元素类型

描述

Location

String

参数解释：

合并后得到对象的路径。

约束限制：

格式：/bucketName/objectName

取值范围：

无

默认取值：

无

Bucket

String

参数解释：

合并段所在的桶名。

约束限制：

  • 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
  • 桶命名规则如下：
    • 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
    • 禁止使用IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻（如：“my..bucket”）。
    • 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。
  • 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

取值范围：

无

默认取值：

无

EncodingType

String

参数解释：

对象Key的编码类型。如果Key包含xml 1.0标准不支持的控制字符，可通过设置encoding-type对响应中的Key进行编码。

约束限制：

无

取值范围：

URL

默认取值：

无，不设置则不编码。

Key

String

参数解释：

合并段后得到的对象名。

对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。

例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。

约束限制：

参见对象概述。

取值范围：

长度大于0且不超过1024的字符。

默认取值：

无

ETag

String

参数解释：

合并段后根据各个段的ETag值计算出的结果，是对象内容的唯一标识。

约束限制：

当对象是服务端加密的对象时，ETag值不是对象的MD5值。

取值范围：

长度为32的字符串。

默认取值：

无

错误响应消息

  1. 如果没有消息体，OBS返回400 Bad Request。
  2. 如果消息体格式不正确，OBS返回400 Bad Request。
  3. 消息体中如果段信息未按照段序号升序排列，OBS返回400 Bad Request，错误码为InvalidPartOrder。
  4. 如果AccessKey或签名无效，OBS返回403 Forbidden， 错误码为AccessDenied。
  5. 如果请求的桶不存在，OBS返回404 Not Found，错误码为NoSuchBucket。
  6. 如果请求的多段上传任务不存在，OBS返回404 Not Found，包含错误信息NoSuchUpload。
  7. 如果用户不是该任务的发起者（initiator），OBS返回403 Forbidden，错误码为AccessDenied。
  8. 在合并段时如果请求段列表中包含了不存在的段，OBS返回400 Bad Request，错误码为InvalidPart。
  9. 如果请求段列表中包含的段的Etag错误，OBS返回400 Bad Request，错误码为InvalidPart。
  10. 除最后一个段之外的其它段尺寸过小（小于100KB），OBS返回400 Bad Request。
  11. 对象在合并完成后总大小如果超过48.8TB，OBS返回400 Bad Request。

其他错误已包含在表2中。

请求示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
POST /object02?uploadId=00000163D46218698DF407362295674C HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Accept: */*
Date: WED, 01 Jul 2015 05:23:46 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:dOfK9iILcKxo58tRp3fWeDoYzKA=
Content-Length: 422

<?xml version="1.0" encoding="utf-8"?>
<CompleteMultipartUpload> 
  <Part> 
    <PartNumber>1</PartNumber>  
    <ETag>a54357aff0632cce46d942af68356b38</ETag> 
  </Part>  
  <Part> 
    <PartNumber>2</PartNumber>  
    <ETag>0c78aef83f66abc1fa1e8477f296d394</ETag> 
  </Part>  
  <Part> 
    <PartNumber>3</PartNumber>  
    <ETag>acbd18db4cc2f85cedef654fccc4a4d8</ETag> 
  </Part>
</CompleteMultipartUpload>

响应示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
 
HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: 8DF400000163D4625BE3075019BD02B8
x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSN8D1AfQcIvyGBZ9+Ee+jU6zv1iYdO4
Content-Type: application/xml
Date: WED, 01 Jul 2015 05:23:46 GMT
Content-Length: 326

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CompleteMultipartUploadResult xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/">
  <Location>/examplebucket/object02</Location>
  <Bucket>examplebucket</Bucket>
  <Key>object02</Key>
  <ETag>"03f814825e5a691489b947a2e120b2d3-3"</ETag>
</CompleteMultipartUploadResult>
父主题： 多段操作

相关文档