- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 计费说明
- 快速入门
- 用户指南
- 权限配置指南
-
工具指南
- OBS工具汇总
-
OBS Browser+
- OBS Browser+简介
- OBS Browser+功能概述
- 下载OBS Browser+
- 安装OBS Browser+
- 登录OBS Browser+
- 桶的基本操作
- 桶的高级配置
- 对象操作
- 任务管理
- 最佳实践
-
常见问题
- 在哪里可以获取AK和SK?
- 如何获取子用户IAM的用户ID?
- 是否可以同时装两个不同站点的OBS Browser+工具?
- OBS Browser+与OBS Browser的不同之处?
- OBS Browser+支持迁移OBS Browser保存的账号信息和任务信息吗?
- 为什么我运行了百万级别的任务后,感觉任务执行较慢?
- 为什么OBS Browser+上显示的桶中对象数量和桶内存储用量与实际的不一致?
- 为什么通过OBS Browser+设置桶ACL后,旧配置中的deliver属性会被覆盖为false?
- 使用账号登录时,界面提示“没有权限登录”
- 使用账号登录时,界面提示“获取用户的Token失败”
- 使用账号登录时,界面提示“账号或者密码错误”
- 定时上传是否采用增量
- 如何永久分享文件或文件夹
- 如何访问指定桶或指定目录
- 目录分享是否支持分享后取消分享
- 是否支持统计文件夹内的文件数目及大小
- 如何解决DNS解析失败
- 是否支持列举特殊字符对象
- 恢复对象任务状态一直是恢复中
- 卸载OBS Browser+
- obsutil
- obsfs
- obsbrowser(已下线)
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
- 快速入门
-
API
- 桶的基础操作
-
桶的高级配置
- 设置桶策略
- 获取桶策略
- 删除桶策略
- 设置桶ACL
- 获取桶ACL
- 设置桶日志管理配置
- 获取桶日志管理配置
- 设置桶的生命周期配置
- 获取桶的生命周期配置
- 删除桶的生命周期配置
- 设置桶的多版本状态
- 获取桶的多版本状态
- 设置桶默认存储类型
- 获取桶默认存储类型
- 设置桶的跨区域复制配置
- 获取桶的跨区域复制配置
- 删除桶的跨区域复制配置
- 设置桶标签
- 获取桶标签
- 删除桶标签
- 设置桶配额
- 获取桶配额
- 获取桶存量信息
- 设置桶清单
- 获取桶清单
- 列举桶清单
- 删除桶清单
- 设置桶的自定义域名
- 获取桶的自定义域名
- 删除桶的自定义域名
- 设置桶的加密配置
- 获取桶的加密配置
- 删除桶的加密配置
- 设置桶归档对象直读策略
- 获取桶归档对象直读策略
- 删除桶归档对象直读策略
- 设置镜像回源规则
- 获取镜像回源规则
- 删除镜像回源规则
- 设置在线解压策略
- 获取在线解压策略
- 删除在线解压策略
- 配置桶级默认WORM策略
- 获取桶级默认WORM策略
- 静态网站托管
- 对象操作
- 多段操作
- 服务端加密
- 错误码
- 权限和授权项
- 附录
-
SDK参考
- SDK概述
- SDK功能矩阵
-
Python
- 使用前须知(Python SDK)
- Python SDK接口概览
- 使用前准备(Python SDK)
- 下载与安装SDK(Python SDK)
- 快速入门(Python SDK)
- 初始化(Python SDK)
-
桶相关接口(Python SDK)
- 创建桶(Python SDK)
- 获取桶列表(Python SDK)
- 判断桶是否存在(Python SDK)
- 删除桶(Python SDK)
- 列举桶内对象(Python SDK)
- 列举桶内多版本对象(Python SDK)
- 获取桶元数据(Python SDK)
- 获取桶区域位置(Python SDK)
- 获取桶存量信息(Python SDK)
- 设置桶配额(Python SDK)
- 获取桶配额(Python SDK)
- 设置桶存储类型(Python SDK)
- 获取桶存储类型(Python SDK)
- 设置桶ACL(Python SDK)
- 获取桶ACL(Python SDK)
- 设置桶日志管理配置(Python SDK)
- 获取桶日志管理配置(Python SDK)
- 设置桶策略(Python SDK)
- 获取桶策略(Python SDK)
- 删除桶策略(Python SDK)
- 设置桶的生命周期配置(Python SDK)
- 获取桶的生命周期配置(Python SDK)
- 删除桶的生命周期配置(Python SDK)
- 设置桶的Website配置(Python SDK)
- 获取桶的Website配置(Python SDK)
- 删除桶的Website配置(Python SDK)
- 设置桶的多版本状态(Python SDK)
- 获取桶的多版本状态(Python SDK)
- 设置桶的CORS配置(Python SDK)
- 获取桶的CORS配置(Python SDK)
- 删除桶的CORS配置(Python SDK)
- 设置桶标签(Python SDK)
- 获取桶标签(Python SDK)
- 删除桶标签(Python SDK)
-
对象相关接口(Python SDK)
- 上传对象简介(Python SDK)
- 上传对象-文本上传(Python SDK)
- 上传对象-流式上传(Python SDK)
- 上传对象-文件上传(Python SDK)
- 上传对象-追加上传(Python SDK)
- 上传对象-断点续传上传(Python SDK)
- 上传对象-获取上传进度(Python SDK)
- 上传对象-基于表单上传(Python SDK)
- 下载对象简介(Python SDK)
- 下载对象-二进制下载(Python SDK)
- 下载对象-流式下载(Python SDK)
- 下载对象-文件下载(Python SDK)
- 下载对象-范围下载(Python SDK)
- 下载对象-断点续传下载(Python SDK)
- 下载对象-获取下载进度(Python SDK)
- 上传对象-创建文件夹(Python SDK)
- 复制对象(Python SDK)
- 删除对象(Python SDK)
- 批量删除对象(Python SDK)
- 获取对象元数据(Python SDK)
- 修改对象元数据(Python SDK)
- 设置对象ACL(Python SDK)
- 获取对象ACL(Python SDK)
- 恢复归档存储对象(Python SDK)
- 多段相关接口(Python SDK)
- 客户端加密相关接口(Python SDK)
- 其他接口(Python SDK)
- 异常处理(Python SDK)
- 常见问题(Python SDK)
-
Java
- 使用前须知(Java SDK)
- Java SDK接口概览(Java SDK)
- 使用前准备(Java SDK)
- 下载与安装SDK(Java SDK)
- 快速入门(Java SDK)
- 初始化(Java SDK)
- 管理桶(Java SDK)
- 管理并行文件系统(Java SDK)
- 上传对象(Java SDK)
- 下载对象(Java SDK)
- 管理对象(Java SDK)
- 临时授权访问(Java SDK)
- 多版本控制(Java SDK)
- 生命周期管理(Java SDK)
- 跨域资源共享(Java SDK)
- 设置访问日志(Java SDK)
- 静态网站托管(Java SDK)
- 桶标签管理(Java SDK)
- 服务端加密(Java SDK)
- 客户端加密(Java SDK)
- 问题定位(Java SDK)
- 异常处理(Java SDK)
-
常见问题(Java SDK)
- 本文档是否适用于union SDK?
- 如何使对象可以被匿名用户访问?(Java SDK)
- SDK的重试机制是什么?(Java SDK)
- 如何获取桶的静态网站访问地址?(Java SDK)
- 如何获取对象URL?(Java SDK)
- 公网环境下如何提高上传大文件速度?(Java SDK)
- 如何进行分段上传?(Java SDK)
- 如何进行分段下载?(Java SDK)
- 如果桶内已存在同名对象,如何判定覆盖上传成功?(Java SDK)
- 对于加密类型的对象如何使用URL进行下载?(Java SDK)
- 如何生成SSE-C方式的加密密钥(Java SDK)
- 如何获取SecurityToken?(Java SDK)
- SDK是否支持批量上传、下载或复制对象?(Java SDK)
- 如何指定Content-SHA256?(Java SDK)
- 为什么SDK源码中包含acs.amazonaws.com关键字?(Java SDK)
- 如何理解Content-Type(MIME)?(Java SDK)
- 如何获取账号ID和用户ID?
-
Go
- 使用前须知(Go SDK)
- Go SDK接口概览
- 使用前准备(Go SDK)
- 下载与安装SDK(Go SDK)
- 快速入门(Go SDK)
- 初始化(Go SDK)
-
桶相关接口(Go SDK)
- 桶相关接口说明(Go SDK)
- 创建桶(Go SDK)
- 获取桶列表(Go SDK)
- 判断桶是否存在(Go SDK)
- 删除桶(Go SDK)
- 列举桶内对象(Go SDK)
- 列举桶内多版本对象(Go SDK)
- 获取桶元数据(Go SDK)
- 获取桶区域位置(Go SDK)
- 获取桶存量信息(Go SDK)
- 设置桶配额(Go SDK)
- 获取桶配额(Go SDK)
- 设置桶存储类型(Go SDK)
- 获取桶存储类型(Go SDK)
- 设置桶ACL(Go SDK)
- 获取桶ACL(Go SDK)
- 设置桶日志管理配置(Go SDK)
- 获取桶日志管理配置(Go SDK)
- 设置桶策略(Go SDK)
- 获取桶策略(Go SDK)
- 删除桶策略(Go SDK)
- 设置桶的生命周期配置(Go SDK)
- 获取桶的生命周期配置(Go SDK)
- 删除桶的生命周期配置(Go SDK)
- 设置桶的网站配置(Go SDK)
- 获取桶的网站配置(Go SDK)
- 删除桶的网站配置(Go SDK)
- 设置桶的多版本状态(Go SDK)
- 获取桶的多版本状态(Go SDK)
- 设置桶的CORS配置(Go SDK)
- 获取桶的CORS配置(Go SDK)
- 删除桶的CORS配置(Go SDK)
- 设置桶标签(Go SDK)
- 获取桶标签(Go SDK)
- 删除桶标签(Go SDK)
- 设置桶加密配置(Go SDK)
- 获取桶加密配置(Go SDK)
- 删除桶加密配置(Go SDK)
- 设置桶的自定义域名(Go SDK)
- 获取桶的自定义域名(Go SDK)
- 删除桶的自定义域名(Go SDK)
- 并行文件系统相关接口(Go SDK)
- 对象相关接口(Go SDK)
- 多段相关接口(Go SDK)
- 其他接口(Go SDK)
- 单链接限速(Go SDK)
- 异常处理(Go SDK)
- 常见问题(Go SDK)
- Android
- C
- BrowserJS
- .NET
- iOS
- PHP
-
Node.js
- SDK下载(Node.js SDK)
- 示例程序(Node.js SDK)
- 快速入门(Node.js SDK)
- 初始化(Node.js SDK)
-
管理桶(Node.js SDK)
- 创建桶(Node.js SDK)
- 列举桶列表(Node.js SDK)
- 判断桶是否存在(Node.js SDK)
- 删除桶(Node.js SDK)
- 获取桶元数据(Node.js SDK)
- 设置桶ACL(Node.js SDK)
- 获取桶ACL(Node.js SDK)
- 设置桶策略(Node.js SDK)
- 获取桶策略(Node.js SDK)
- 删除桶策略(Node.js SDK)
- 获取桶区域位置(Node.js SDK)
- 获取桶存量信息(Node.js SDK)
- 设置桶配额(Node.js SDK)
- 获取桶配额(Node.js SDK)
- 设置桶存储类别(Node.js SDK)
- 获取桶存储类别(Node.js SDK)
- 上传对象(Node.js SDK)
- 下载对象(Node.js SDK)
- 管理对象(Node.js SDK)
- 多段相关接口(Node.js SDK)
- 临时授权访问(Node.js SDK)
- 多版本控制(Node.js SDK)
- 生命周期管理(Node.js SDK)
- 桶的CORS配置(Node.js SDK)
- 设置访问日志(Node.js SDK)
- 静态网站托管(Node.js SDK)
- 标签管理(Node.js SDK)
- 服务端加密(Node.js SDK)
- 异常处理(Node.js SDK)
- 常见问题(Node.js SDK)
- 视频帮助
-
常见问题
-
产品咨询
- 如何获取OBS的终端节点?
- 我可以在OBS中存储多少数据?
- 我如何选择将数据存储在哪个区域?
- OBS支持使用HTTPS协议访问吗?
- OBS中的数据可以让其他用户访问吗?
- 访问OBS链接提示告警信息的原因和解决办法
- 已删除的数据是否可以恢复?
- 访问OBS域名失败,连接不上CA证书
- 为什么OBS存储的数据丢失了?
- OBS是否支持流量监控?
- OBS上传下载速率的影响因素有哪些?
- 对象存储与SAN存储和NAS存储相比较有什么优势?
- OBS的文件夹与文件系统的文件夹是否一样?
- OBS、EVS和SFS有什么区别?
- 如何判断是否内网访问OBS?
- 我的OBS桶性能是否会受其他用户业务的影响?
- OBS桶概览页数据不一致的原因是什么?
- 境外数据传输回国场景下的丢包和网络稳定性问题
-
计费相关
- 桶内无对象,为什么还会产生存储费用?
- 桶内无对象为什么会产生流量?
- 已购买资源包,为什么仍然扣费?
- 配置CDN回源,并购买回源流量包,计费未走回源流量包
- 账号欠费后已充值,为什么OBS资源仍然不可用?
- 资源包是否必须购买?是否能指定给具体的桶使用?
- 资源包是否支持退订或修改?
- 资源包到期后OBS资源会如何处理?
- 并行文件系统是否支持资源包?
- 请求次数是如何计算的?
- 是否支持购买请求次数?
- OBS存储资源包使用超量后是否会限制对桶的写入
- 当月未用完的资源包用量是否会结转到下个月?
- 哪些资源包会按月更新额度,哪些不会?
- 购买了回源流量包是否还需要购买公网流出流量包?
- OBS账单为什么会出现0.01美元的计费?
- 查询账单时,为什么会有大量的公网流出流量?
- 权限相关
-
桶和对象相关
- 创建桶失败
- 上传对象失败
- 下载对象失败
- 删除桶失败
- 删除对象失败
- 通过URL访问对象失败
- 如何在浏览器中在线预览OBS中的对象?
- 我可以修改对象名称吗?
- 我可以在线编辑OBS中的对象吗?
- 如何获取对象访问路径?
- 我可以修改桶所在的区域吗?
- 如何修改桶所属的企业项目?
- 我可以在桶间进行文件复制吗?
- 我可以在桶间进行文件移动吗?
- 我可以上传同名对象到同一个文件夹中吗?
- OBS是否支持断点续传功能?
- OBS是否支持批量上传文件?
- OBS是否支持批量下载文件?
- OBS是否支持批量删除对象或清空桶?
- 无法搜索到桶中对象或对象不存在返回403
- 使用IE浏览器访问带有中文字符的对象URL地址报错如何处理?
- 为什么配置了跨域访问OBS(CORS)仍然报错?
- 如何查看桶内的文件夹大小?
- 如何上传超过5GB的大对象?
- 数据安全、迁移和备份
- 多版本控制
- 服务端加密
- 跨区域复制
- 域名管理
- 静态网站托管
- 图片处理
- 并行文件系统
- 监控
- OBS控制台使用相关
- OBS Browser+和obsutil等工具相关
- API和SDK等开发者相关
-
产品咨询
- 产品术语
-
更多文档
- 用户指南(阿布扎比区域)
- API参考(阿布扎比区域)
- 工具指南(OBS Browser+)(阿布扎比区域)
- 工具指南(obsfs)(阿布扎比区域)
- 工具指南(obsutil)(阿布扎比区域)
- 并行文件系统特性指南(阿布扎比区域)
-
用户指南 (巴黎区域)
- 产品介绍
- 控制台指南
-
常见问题
-
产品咨询
- 如何获得对象存储服务?
- 如何获取OBS的终端节点?
- 对象存储与SAN存储和NAS存储相比较有什么优势?
- 我可以存储哪种类型的数据?
- 我可以在OBS中存储多少数据?
- OBS是否支持流量监控?
- OBS的文件夹与文件系统的文件夹是否一样?
- OBS的数据存储在哪里?
- OBS支持HTTPS访问吗?
- OBS中的数据可以让其他用户访问吗?
- OBS是否支持断点续传功能?
- OBS是否支持批量上传文件?
- OBS是否支持批量下载文件?
- OBS是否支持批量删除对象?
- OBS上传下载速率的影响因素有哪些?
- 为什么OBS存储的数据丢失了?
- 已删除的数据是否可以恢复?
- 已删除的数据在OBS中是否会有残留?
- 我的OBS桶性能是否会受其他用户业务的影响?
- 权限相关
- 桶和对象相关
- 工具相关
- API和SDK等开发者相关
- 安全性
- 碎片管理
- 多版本控制
- 事件通知
- 生命周期管理
- 静态网站托管
- 跨区域复制
- 服务端加密
-
产品咨询
- 修订记录
- 工具指南(OBS Browser+)(巴黎区域)
- 工具指南(obsfs)(巴黎区域)
- 工具指南(obsutil)(巴黎区域)
- 并行文件系统特性指南(巴黎区域)
- 图片处理特性指南(巴黎地区)
- 权限配置指南(巴黎区域)
- 用户指南(吉隆坡区域)
- API参考(吉隆坡区域)
- 工具指南(OBS Browser+)(吉隆坡区域)
- 工具指南(obsfs)(吉隆坡区域)
- 并行文件系统特性指南(吉隆坡区域)
- 最佳实践(吉隆坡区域)
- 用户指南(安卡拉区域)
- API参考(安卡拉区域)
- 并行文件系统特性指南(安卡拉区域)
- 工具指南(OBS Browser+)(安卡拉区域)
- 工具指南(obsutil)(安卡拉区域)
- 操作指南(此文档即将下线,请查阅用户指南)
- 图片处理(此文档即将下线,请查阅用户指南)
- 并行文件系统(此文档即将下线,请查阅用户指南)
- 通用参考
链接复制成功!
分段上传-列举分段上传任务(Python SDK)
功能说明
列举指定桶中所有的初始化后还未合并或还未取消的分段上传任务。
通过列举桶中的多段上传任务,您可以获得已初始化多段上传任务的列表,已初始化多段上传任务是指初始化后还未合并以及未取消的多段上传任务。每个请求将返回最多1000个多段上传任务,如果正在进行的多段上传任务超过1000个,您需要发送其他请求以检索剩余的多段上传任务。
接口约束
- 您必须是桶拥有者或拥有列举分段上传任务的权限,才能列举分段上传任务。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:ListBucketMultipartUploads权限,如果使用桶策略则需授予ListBucketMultipartUploads权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、配置对象策略。
- OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点。
- 您必须得到可以对桶执行ListBucketMultipartUploads操作的权限,才能列出正在上传到该桶的多段上传。
- 默认情况下,允许桶所有者和多段上传任务的发起者执行此操作。除了默认情况之外,桶所有者可以允许其他委托人对桶执行ListBucketMultipartUploads操作。
方法定义
ObsClient.listMultipartUploads(bucketName, multipart, extensionHeaders)
请求参数
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
bucket |
str |
必选 |
参数解释: 桶名。 约束限制:
默认取值: 无 |
multipart |
可选 |
参数解释: 列举分段上传任务请求参数。ListMultipartUploadsRequest。 |
|
extensionHeaders |
dict |
可选 |
参数解释: 接口的拓展头域。 取值范围: 参考自定义头域。 默认取值: 无 |
encoding_type |
str |
可选 |
参数解释: 用于指定对响应中的Key进行指定类型的编码。如果Key包含xml 1.0标准不支持的控制字符,可通过设置该参数对响应中的Key进行编码。 取值范围: 可选值为url。 默认取值: 无,不设置则不编码。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
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值。 默认取值: 无 |
返回结果
类型 |
说明 |
---|---|
参数解释: SDK公共结果对象。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
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时为空。该值根据调用接口的不同而不同,参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值: 无 |
GetResult.body类型 |
说明 |
---|---|
参数解释: 列举桶内分段上传任务响应结果。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
bucket |
str |
参数解释: 桶名。 约束限制:
默认取值: 无 |
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 |
参数解释: 表明本次请求是否返回了全部结果。 取值范围:
默认取值: 无 |
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。 默认取值: 无,不设置则不编码。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
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。 默认取值: 无 |
|
owner |
参数解释: 和initiator相同,代表分段上传任务的创建者。详见Owner。 默认取值: 无 |
|
storageClass |
str |
参数解释: 分段上传的对象的存储类型。 取值范围: 存储类型取值范围参见存储类型。 默认取值: 无 |
initiated |
str |
参数解释: 分段上传任务的初始化时间。 约束限制: 日期格式必须为ISO8601的格式。 例如:2018-01-01T00:00:00.000Z。 代码示例:DateTime(year=2023, month=9, day=12)。 默认取值: 无 |
参数名称 |
参数类型 |
描述 |
---|---|---|
prefix |
str |
参数解释: 当请求中设置了delimiter分组字符时,返回按delimiter分组后的对象名称前缀列表。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
id |
str |
作为请求参数时必选 |
参数解释: 创建者的账号ID,即domain_id。 取值范围: 如何获取账号ID请参见获取账号ID。 默认取值: 无 |
name |
str |
作为请求参数时可选 |
参数解释: 创建者账号名。 约束限制: 账号名不支持中文,只能包含英文字母、数字或特殊字符“-_”,且须以字母开头,账号名长度支持6~32个字符。 默认取值: 无 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
owner_id |
str |
作为请求参数时必选 |
参数解释: 所有者的账号ID,即domain_id。 取值范围: 如何获取账号ID请参见如何获取账号ID和用户ID? 默认取值: 无 |
owner_name |
str |
作为请求参数时可选 |
参数解释: 所有者的账号用户名。 取值范围: 如何获取账号用户名请参见如何获取用户名? 默认取值: 无 |
代码样例
本示例用于列举桶内的分段上传任务。
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()) |
相关链接
- 关于分段上传-列举分段上传任务的API说明,请参见列举桶中已初始化多段任务。
- 更多关于分段上传的示例代码,请参见Github示例。
- 分段上传过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。