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

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。

默认取值：

无，不设置则不编码。

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值。

默认取值：

无

GetResult

参数解释：

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

默认取值：

无

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。

默认取值：

无，不设置则不编码。

key

str

参数解释：

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

例如，您对象的访问地址为examplebucket.obs.cn-north-4.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)。

默认取值：

无

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

作为请求参数时可选

参数解释：

所有者的账号用户名。

取值范围：

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

默认取值：

无

STANDARD

标准存储

参数解释：

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

WARM

低频访问存储

参数解释：

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

COLD

归档存储

参数解释：

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

DEEP_ARCHIVE

深度归档存储（受限公测）

参数解释：

深度归档存储适用于长期不访问（平均几年访问一次）数据的业务场景。