文档首页/ 对象存储服务 OBS/ SDK参考/ Python/ 多段相关接口(Python SDK)/ 分段上传-列举已上传的段(Python SDK)
更新时间：2024-11-26 GMT+08:00
查看PDF
分享

分段上传-列举已上传的段(Python SDK)

功能说明

通过分段上传任务的ID，列举指定桶中已上传的段。

您可以列出特定多段上传任务或所有正在进行的多段上传任务的分段。列举已上传的段操作将返回您已为特定多段上传任务而上传的段信息。对于每个列举已上传的段请求，OBS将返回有关特定多段上传任务的分段信息，最多为1000个分段。如果多段上传中的段超过1000个，您必须发送一系列列举已上传的段请求以检索所有段。请注意，返回的分段列表不包括已合并的分段。

接口约束

  • 您必须是桶拥有者或拥有列举已上传的段的权限，才能列举已上传的段。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:ListMultipartUploadParts权限，如果使用桶策略则需授予ListMultipartUploadParts权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。
  • OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。
  • 仅使用返回的列表进行验证。发送完成多段上传请求时，您不应使用此列表的结果。但是，当上传段和OBS返回的相应的ETag值时，将保留您自己的指定段编号的列表。

方法定义

ObsClient.listParts(bucketName, objectKey, uploadId, maxParts, partNumberMarker, extensionHeaders)

请求参数

表1 请求参数列表

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释：

桶名。

约束限制：

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

默认取值：

无

objectKey

str

必选

参数解释：

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

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

取值范围：

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

默认取值：

无

说明：

对象链接地址格式为：https://桶名.域名/文件夹目录层级/对象名。如果该对象存在于桶的根目录下，则链接地址将不需要有文件夹目录层级。

uploadId

str

必选

参数解释：

分段上传任务的ID，例如：000001648453845DBB78F2340DD460D8

取值范围：

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

默认取值：

无

maxParts

int

可选

参数解释：

列举已上传段的返回结果最大段数目，即分页时每一页中段数目。

约束限制：

如果该参数超出1000时，则按照默认的1000进行处理。

取值范围：

[1，1000]

默认取值：

1000

partNumberMarker

int

可选

参数解释：

列举已上传段的起始位置。

约束限制：

只有PartNumber数目大于该参数的Part会被列出

默认取值：

无

extensionHeaders

dict

可选

参数解释：

接口的拓展头域。

取值范围：

参考自定义头域。

默认取值：

无

encoding_type

str

可选

参数解释：

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

取值范围：

可选值为url。

默认取值：

无，不设置则不编码。

返回结果

表2 返回结果

类型

说明

GetResult

参数解释：

SDK公共结果对象。
表3 GetResult

参数名称

参数类型

描述

status

int

参数解释：

HTTP状态码。

取值范围：

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。

默认取值：

无

reason

str

参数解释：

HTTP文本描述。

默认取值：

无

errorCode

str

参数解释：

OBS服务端错误码，当status参数小于300时为空。

默认取值：

无

errorMessage

str

参数解释：

OBS服务端错误描述，当status参数小于300时为空。

默认取值：

无

requestId

str

参数解释：

OBS服务端返回的请求ID。

默认取值：

无

indicator

str

参数解释：

OBS服务端返回的错误定位码。

默认取值：

无

hostId

str

参数解释：

请求的服务端ID，当status参数小于300时为空。

默认取值：

无

resource

str

参数解释：

发生错误时相关的桶或对象，当status参数小于300时为空。

默认取值：

无

header

list

参数解释：

响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。

默认取值：

无

body

object

参数解释：

操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。

默认取值：

无
表4 GetResult.body

GetResult.body类型

说明

ListPartsResponse

参数解释：

列举段响应结果。
表5 ListPartsResponse

参数名称

参数类型

描述

bucketName

str

参数解释：

桶名。

约束限制：

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

默认取值：

无

objectKey

str

参数解释：

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

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

取值范围：

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

默认取值：

无

uploadId

str

参数解释：

分段上传任务的ID，例如：000001648453845DBB78F2340DD460D8

取值范围：

长度为32的字符串。

默认取值：

无

initiator

Initiator

参数解释：

分段上传任务的创建者，详见Initiator。

默认取值：

无

owner

Owner

参数解释：

和initiator相同，代表分段上传任务的创建者，详见Owner。

默认取值：

无

storageClass

str

参数解释：

待合并对象的存储类型。

取值范围：

存储类型取值参见存储类型。

默认取值：

无

partNumberMarker

int

参数解释：

列举段的起始位置，与请求中的该参数对应。

取值范围：

大于等于0的整型数。

默认取值：

无

nextPartNumberMarker

int

参数解释：

下次列举段请求的起始位置。如果本次没有返回全部结果，响应请求中将包含此字段，用于标明接下来请求的partNumberMarker值。

取值范围：

大于等于0的整型数。

默认取值：

无

maxParts

int

参数解释：

列举段的返回结果最大段数目，与请求中的该参数对应。列举已上传段的返回结果最大段数目，即分页时每一页中段数目。

约束限制：

如果该参数超出取值范围时，按照默认的1000进行处理。

取值范围：

[1，1000]

默认取值：

1000

isTruncated

bool

参数解释：

表明本次请求是否返回了全部结果。

取值范围：

  • true：表示没有返回全部结果。
  • false：表示已返回了全部结果。

默认取值：

无

parts

list of Part

参数解释：

已上传段信息列表，详见Part。

默认取值：

无

encoding_type

str

参数解释：

对响应中的部分元素进行指定类型的编码。如果 delimiter、key_marker、prefix、nextKeyMarker 和 key 包含 xml 1.0 标准不支持的控制字符，可通过设置 encoding_type 对响应中的 delimiter、key_marker、prefix（包括 commonPrefixes 中的 Prefix）、nextKeyMarker 和 key 进行编码。

取值范围：

可选值：url。

默认取值：

无，不设置则不编码。
表6 StorageClass

参数名称

参数类型

描述

STANDARD

标准存储

参数解释：

标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（<1MB），且需要频繁访问数据的业务场景。

WARM

低频访问存储

参数解释：

低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。

COLD

归档存储

参数解释：

归档存储适用于很少访问（平均一年访问一次）数据的业务场景。
表7 Initiator

参数名称

参数类型

是否必选

描述

id

str

作为请求参数时必选

参数解释：

创建者的账号ID，即domain_id。

取值范围：

如何获取账号ID请参见获取账号ID。

默认取值：

无

name

str

作为请求参数时可选

参数解释：

创建者账号名。

约束限制：

账号名不支持中文，只能包含英文字母、数字或特殊字符“-_”，且须以字母开头，账号名长度支持6~32个字符。

默认取值：

无
表8 Owner

参数名称

参数类型

是否必选

描述

owner_id

str

作为请求参数时必选

参数解释：

所有者的账号ID，即domain_id。

取值范围：

如何获取账号ID请参见如何获取账号ID和用户ID?

默认取值：

无

owner_name

str

作为请求参数时可选

参数解释：

所有者的账号用户名。

取值范围：

如何获取账号用户名请参见如何获取用户名?

默认取值：

无
表9 Part

参数名称

参数类型

描述

partNumber

int

参数解释：

段号。

取值范围：

取值范围是[1,10000]的非负整数。

默认取值：

无

lastModified

str

参数解释：

段的最后上传时间。

默认取值：

无

etag

str

参数解释：

段的ETag值。分段的base64编码的128位MD5摘要。

取值范围：

长度为32的字符串。

默认取值：

无

size

int

参数解释：

段的大小。

默认取值：

无

代码样例

本示例用于列举指定uploadId多段任务中已上传的段。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
from obs import ObsClient
import os
import traceback

# 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
# 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# 【可选】如果使用临时AKSK和SecurityToken访问OBS，则同样推荐通过环境变量获取
# security_token = os.getenv("SecurityToken")
# server填写Bucket对应的Endpoint, 这里以中国-香港为例，其他地区请按实际情况填写
server = "https://obs.ap-southeast-1.myhuaweicloud.com" 
# 创建obsClient实例
# 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    bucketName = "examplebucket"
    objectKey = "objectname"
    # 分段上传任务的ID
    uploadId = "your uploadid"
    # 列举已上传段的返回结果最大段数目，即分页时每一页中段数目，此处为10
    maxParts = 10
    # 列举指定桶中已上传的段
    resp = obsClient.listParts(bucketName, objectKey, uploadId, maxParts, encoding_type='url')

    # 返回码为2xx时，接口调用成功，否则接口调用失败
    if resp.status < 300:
        print('List Parts Succeeded')
        print('requestId:', resp.requestId)
        print('bucketName:', resp.body.bucketName)
        print('objectKey:', resp.body.objectKey)
        print('uploadId:', resp.body.uploadId)
        print('storageClass:', resp.body.storageClass)
        print('isTruncated:', resp.body.isTruncated)
        print('initiator:', resp.body.initiator)
        print('owner:', resp.body.owner)

        index = 1
        for part in resp.body.parts:
            print('part [' + str(index) + ']')
            print('partNumber:', part.partNumber)
            print('lastModified:', part.lastModified)
            print('etag:', part.etag)
            print('size:', part.size)
            index += 1
    else:
        print('List Parts Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except:
    print('List Parts Failed')
    print(traceback.format_exc())

相关链接

  • 关于分段上传-列举已上传的段的API说明，请参见列举已上传的段。
  • 更多关于分段上传的示例代码，请参见Github示例。
  • 分段上传过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。