计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
态势感知 SA
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive
文档首页/ 对象存储服务 OBS/ SDK参考/ Python/ 多段相关接口(Python SDK)/ 分段上传-列举分段上传任务(Python SDK)

分段上传-列举分段上传任务(Python SDK)

更新时间:2024-11-26 GMT+08:00

功能说明

列举指定桶中所有的初始化后还未合并或还未取消的分段上传任务。

通过列举桶中的多段上传任务,您可以获得已初始化多段上传任务的列表,已初始化多段上传任务是指初始化后还未合并以及未取消的多段上传任务。每个请求将返回最多1000个多段上传任务,如果正在进行的多段上传任务超过1000个,您需要发送其他请求以检索剩余的多段上传任务。

接口约束

  • 您必须是桶拥有者或拥有列举分段上传任务的权限,才能列举分段上传任务。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:ListBucketMultipartUploads权限,如果使用桶策略则需授予ListBucketMultipartUploads权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略配置对象策略
  • OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点
  • 您必须得到可以对桶执行ListBucketMultipartUploads操作的权限,才能列出正在上传到该桶的多段上传。
  • 默认情况下,允许桶所有者和多段上传任务的发起者执行此操作。除了默认情况之外,桶所有者可以允许其他委托人对桶执行ListBucketMultipartUploads操作。

方法定义

ObsClient.listMultipartUploads(bucketName, multipart, extensionHeaders)

请求参数

表1 请求参数列表

参数名称

参数类型

是否必选

描述

bucket

str

必选

参数解释

桶名。

约束限制:

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

默认取值:

multipart

ListMultipartUploadsRequest

可选

参数解释

列举分段上传任务请求参数。ListMultipartUploadsRequest

extensionHeaders

dict

可选

参数解释:

接口的拓展头域。

取值范围:

参考自定义头域

默认取值:

encoding_type

str

可选

参数解释:

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

取值范围:

可选值为url。

默认取值:

无,不设置则不编码。

表2 ListMultipartUploadsRequest

参数名称

参数类型

是否必选

描述

prefix

str

可选

参数解释:

限定返回的分段上传任务中的对象名必须带有prefix前缀。

例如,假设您拥有以下对象:logs/day1、logs/day2、logs/day3和ExampleObject.jpg。如果您将logs/指定为前缀,将返回以字符串“logs/”开头的三个对象所在的分段上传任务。如果您指定空的前缀且请求中没有其他过滤条件,将返回桶中的所有分段上传任务。

约束限制:

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

默认取值:

max_uploads

int

str

可选

参数解释:

列举分段上传任务的最大数目。

约束限制:

当该参数超出1000时,按照默认的1000进行处理。

取值范围:

1~1000,单位:个。

默认取值:

1000

delimiter

str

可选

参数解释:

对分段上传任务中的对象名进行分组的字符。通常与前缀prefix搭配使用,如果指定了prefix,从prefix到第一次出现delimiter间具有相同字符串的对象名会被分成一组,形成一条CommonPrefix;如果没有指定prefix,从对象名的首字符到第一次出现delimiter间具有相同字符串的对象名会被分成一组,形成一条CommonPrefix。

例如,桶中有3个对象,分别为abcd、abcde、bbcde。如果指定delimiter为d,prefix为a,abcd、abcde会被分成一组,形成一条前缀为abcd的CommonPrefix;如果只指定delimiter为d,abcd、abcde会被分成一组,形成一条前缀为abcd的CommonPrefix,而bbcde会被单独分成一组,形成一条前缀为bbcd的CommonPrefix。

取值范围:

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

默认取值:

key_marker

str

可选

参数解释:

列举分段上传任务的起始位置。表示列举时返回指定的key_marker之后的分段上传任务。

取值范围:

上次请求返回体的nextKeyMarker值。

默认取值:

upload_id_marker

str

可选

参数解释:

列举分段上传任务的起始位置(uploadId标识)。

约束限制:

只有与key_marker参数一起使用时才有意义,即列举时返回指定keyMarker的uploadIdMarker之后的分段上传任务。

取值范围:

对象的分段上传任务ID,即上次请求返回体的nextUploadIdMarker值。

默认取值:

返回结果

表3 返回结果

类型

说明

GetResult

参数解释:

SDK公共结果对象。

表4 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时为空。该值根据调用接口的不同而不同,参见“桶相关接口”章节和“对象相关接口”章节的详细描述。

默认取值:

表5 GetResult.body

GetResult.body类型

说明

ListMultipartUploadsResponse

参数解释:

列举桶内分段上传任务响应结果。

表6 ListMultipartUploadsResponse

参数名称

参数类型

描述

bucket

str

参数解释

桶名。

约束限制:

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

默认取值:

keyMarker

str

参数解释:

列举分段上传任务的起始位置,与请求中的该参数对应。

取值范围:

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

默认取值:

uploadIdMarker

str

参数解释:

列举分段上传任务的起始位置(uploadId标识),与请求中的该参数对应。

取值范围:

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

默认取值:

nextKeyMarker

str

参数解释:

下次列举分段上传任务请求的起始位置。如果本次没有返回全部结果,响应请求中将包含该元素,用于标明接下来请求的key_marker值。

取值范围:

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

默认取值:

nextUploadIdMarker

str

参数解释:

下次列举分段上传任务请求的起始位置(uploadId标识)。与nextKeyMarker配合使用。如果本次没有返回全部结果,响应请求中将包含该元素,用于标明接下来请求的upload_id_marker值。

取值范围:

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

默认取值:

maxUploads

int

参数解释:

列举分段上传任务的最大数目,与请求中的该参数对应。

约束限制:

当该参数超出范围时,按照默认的1000进行处理。

取值范围:

1~1000,单位:个。

默认取值:

1000

isTruncated

bool

参数解释:

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

取值范围:

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

默认取值:

prefix

str

参数解释:

分段上传任务中的对象名前缀,与请求中的该参数对应。限定返回的分段上传任务中的对象名必须带有prefix前缀。

例如,假设您拥有以下对象:logs/day1、logs/day2、logs/day3和ExampleObject.jpg。如果您将logs/指定为前缀,将返回以字符串“logs/”开头的三个对象所在的分段上传任务。如果您指定空的前缀且请求中没有其他过滤条件,将返回桶中的所有分段上传任务。

约束限制:

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

默认取值:

delimiter

str

参数解释:

用于对分段上传任务中的对象名进行分组的字符,与请求中的该参数对应。通常与前缀prefix搭配使用,如果指定了prefix,从prefix到第一次出现delimiter间具有相同字符串的对象名会被分成一组,形成一条CommonPrefixes;如果没有指定prefix,从对象名的首字符到第一次出现delimiter间具有相同字符串的对象名会被分成一组,形成一条CommonPrefixes。

例如,桶中有3个对象,分别为abcd、abcde、bbcde。如果指定delimiter为d,prefix为a,abcd、abcde会被分成一组,形成一条前缀为abcd的CommonPrefixes;如果只指定delimiter为d,abcd、abcde会被分成一组,形成一条前缀为abcd的CommonPrefixes,而bbcde会被单独分成一组,形成一条前缀为bbcd的CommonPrefixes。

取值范围:

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

默认取值:

upload

list of Upload

参数解释:

桶内分段上传任务列表,详见Upload

默认取值:

commonPrefixs

list of CommonPrefix

参数解释:

当请求中设置了delimiter分组字符时,返回按delimiter分组后的对象名称前缀列表。

取值范围:

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

默认取值:

encoding_type

str

参数解释:

用于指定对响应中的key(分段上传任务的对象名)进行指定类型的编码。如果包含xml 1.0标准不支持的控制字符,可通过设置该参数对响应中的key进行编码。

取值范围:

可选值为url。

默认取值:

无,不设置则不编码。

表7 Upload

参数名称

参数类型

描述

key

str

参数解释:

分段上传任务的对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径,路径中不包含桶名。

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

取值范围:

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

默认取值:

uploadId

str

参数解释:

分段上传任务的ID,例如:000001648453845DBB78F2340DD460D8

取值范围:

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

默认取值:

initiator

Initiator

参数解释:

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

默认取值:

owner

Owner

参数解释:

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

默认取值:

storageClass

str

参数解释:

分段上传的对象的存储类型。

取值范围:

存储类型取值范围参见存储类型

默认取值:

initiated

str

参数解释:

分段上传任务的初始化时间。

约束限制:

日期格式必须为ISO8601的格式。 例如:2018-01-01T00:00:00.000Z。

代码示例:DateTime(year=2023, month=9, day=12)。

默认取值:

表8 CommonPrefix

参数名称

参数类型

描述

prefix

str

参数解释:

当请求中设置了delimiter分组字符时,返回按delimiter分组后的对象名称前缀列表。

取值范围:

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

默认取值:

表9 Initiator

参数名称

参数类型

是否必选

描述

id

str

作为请求参数时必选

参数解释:

创建者的账号ID,即domain_id。

取值范围:

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

默认取值:

name

str

作为请求参数时可选

参数解释:

创建者账号名。

约束限制:

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

默认取值:

表10 Owner

参数名称

参数类型

是否必选

描述

owner_id

str

作为请求参数时必选

参数解释:

所有者的账号ID,即domain_id。

取值范围:

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

默认取值:

owner_name

str

作为请求参数时可选

参数解释:

所有者的账号用户名。

取值范围:

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

默认取值:

表11 StorageClass

参数名称

参数类型

描述

STANDARD

标准存储

参数解释:

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

WARM

低频访问存储

参数解释:

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

COLD

归档存储

参数解释:

归档存储适用于很少访问(平均一年访问一次)数据的业务场景。

代码样例

本示例用于列举桶内的分段上传任务。

 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
from obs import ListMultipartUploadsRequest
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"
    # 限定返回的分段上传任务中的对象名必须带有prefix前缀
    prefix = 'prefix'
    # 列举分段上传任务的最大数目,取值范围为1~1000,当超出范围时,按照默认的1000进行处理,此处为10
    max_uploads = 10
    # 列举桶内分段上传任务请求参数
    multipart = ListMultipartUploadsRequest(prefix=prefix, max_uploads=max_uploads)
    # 列举桶内分段上传任务
    resp = obsClient.listMultipartUploads(bucketName, multipart, encoding_type='url')

    # 返回码为2xx时,接口调用成功,否则接口调用失败
    if resp.status < 300:
        print('List Multipart Uploads Succeeded')
        print('requestId:', resp.requestId)
        print('bucket:', resp.body.bucket)
        print('prefix:', resp.body.prefix)
        print('maxUploads:', resp.body.maxUploads)
        print('isTruncated:', resp.body.isTruncated)
        index = 1
        for upload in resp.body.upload:
            print('upload [' + str(index) + ']')
            print('key:', upload.key)
            print('uploadId:', upload.uploadId)
            print('storageClass:', upload.storageClass)
            print('initiated:', upload.initiated)
            print('owner_id:', upload.owner.owner_id)
            print('owner_name:', upload.owner.owner_name)
            index += 1
    else:
        print('List Multipart Uploads Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except:
    print('List Multipart Uploads Failed')
    print(traceback.format_exc())

相关链接

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容