对象存储服务 OBS-分段上传-列举分段上传任务(Python SDK):请求参数

时间:2024-10-10 11:58:27

请求参数

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

默认取值:

support.huaweicloud.com/sdk-python-devg-obs/obs_22_1005.html