对象存储服务 OBS-上传对象-文本上传(Python SDK):请求参数

时间：2024-12-27 15:57:36

请求参数

表1 请求参数列表
参数名称	参数类型	是否必选	描述
bucketName	str	必选	参数解释：桶名。约束限制：桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。禁止使用IP地址。禁止以“-”或“.”开头及结尾。禁止两个“.”相邻（如：“my..bucket”）。禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。默认取值：无
objectKey	str	必选	参数解释：对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。取值范围：长度大于0且不超过1024的字符串。默认取值：无
content	str 或 readable object	可选	参数解释：待上传对象的内容。取值范围：字符串或者可读对象。说明：如果content是可读对象（包含“read”属性），则从中读取数据，否则作为字符串处理。默认取值：无
metadata	dict	可选	参数解释：待上传对象的自定义元数据。OBS支持用户使用以“x-obs-meta-”开头的消息头来加入自定义的元数据，以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时，加入的自定义元数据将会在返回的消息头中出现。约束限制：所有自定义元数据大小的总和不超过8K。单个自定义元数据大小的计算方式为：每个键和值的UTF-8 编码中的字节总数。自定义元数据的key值不区分大小写，OBS统一转为小写进行存储。value值区分大小写。自定义元数据key-value对都必须符合US-ASCII标准。如果一定要使用非ASCII码或不可识别字符，需要客户端自行做编解码处理，可以采用URL编码或者Base64编码，服务端不会做解码处理。例如x-obs-meta-中文：中文经URL编码后发送，“中文”的URL编码为：%E4%B8%AD%E6%96%87，则响应为x-obs-meta-%E4%B8%AD%E6%96%87: %E4%B8%AD%E6%96%87 默认取值：无
headers	PutObjectHeader	可选	参数解释：上传对象的头域，用于设置对象的基本信息，包括存储类别、冗余策略等。取值范围：参考PutObjectHeader。默认取值：无
progressCallback	callable	可选	参数解释：获取上传进度的回调函数。默认取值：无说明：该回调函数依次包含三个参数：已上传的字节数、总字节数、已使用的时间（单位：秒），示例代码参考上传对象-获取上传进度。上传进度回调功能仅支持流式上传、文件上传、上传段、追加上传和断点续传上传。
autoClose	bool	可选	参数解释：上传完成后，自动关闭数据流。取值范围： True：自动关闭数据流。 False：不开启自动关闭数据流。默认取值： True
extensionHeaders	dict	可选	参数解释：接口的拓展头域。取值范围：参考自定义头域。默认取值：无