修改对象元数据(Python SDK)
功能说明
元数据(Metadata)为描述对象属性的信息,是一组名称值对,用作对象管理的一部分。
当前仅支持系统定义的元数据。
系统定义的元数据又分为两种类别:系统控制和用户控制。如Last-Modified日期等数据由系统控制,不可修改;如为对象配置的ContentLanguage,用户可以通过接口进行修改。
可以通过本接口添加、修改或删除桶中已经上传的对象的元数据。
接口约束
- 您必须是桶拥有者或拥有设置对象元数据的权限,才能设置对象元数据。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:object:ModifyObjectMetaData权限,如果使用桶策略则需授予ModifyObjectMetaData权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、配置对象策略。
- OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点。
- 当桶开启多版本控制时,最新版本的对象支持设置元数据,历史版本的对象不支持设置元数据。
- 对于存储类别为归档存储的对象,不能对其设置对象的元数据。
方法定义
ObsClient.setObjectMetadata(bucketName, objectKey, metadata, headers, versionId)
请求参数
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
bucketName |
str |
必选 |
参数解释: 桶名。 约束限制:
默认取值: 无 |
objectKey |
str |
必选 |
参数解释: 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径,路径中不包含桶名。 例如,您对象的访问地址为examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt 中,对象名为folder/test.txt。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
metadata |
dict |
可选 |
参数解释: 对象的自定义元数据。OBS支持用户使用以“x-obs-meta-”开头的消息头来加入自定义的元数据,以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时,加入的自定义元数据将会在返回的消息头中出现。 约束限制:
默认取值: 无 |
headers |
可选 |
参数解释: 设置对象元数据的头域,用于设置对象元数据的基本信息,详见SetObjectMetadataHeader。 |
|
versionId |
str |
可选 |
参数解释: 对象的版本号。例如:G001117FCE89978B0000401205D5DC9A。 取值范围: 长度为32的字符串。 默认取值: 无 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
removeUnset |
bool |
可选 |
参数解释: 用于设置元数据操作指示符。 取值范围: True:表示指定元数据操作指示符为REPLACE。REPLACE表示使用当前请求中携带的头域完整替换,未指定的元数据会被删除。 False:表示指定元数据操作指示符为REPLACE_NEW。REPLACE_NEW表示对于已经存在值的元数据进行替换,不存在值的元数据进行赋值,未指定的元数据保持不变。 默认取值: False |
location |
str |
可选 |
参数解释: 当桶设置了Website配置,可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL。 例如,重定向请求到桶内另一对象: WebsiteRedirectLocation:/anotherPage.html 或重定向请求到一个外部URL: WebsiteRedirectLocation:http://www.example.com/ OBS将这个值从头域中取出,保存在对象的元数据“WebsiteRedirectLocation”中。 约束限制:
默认取值: 无 |
cacheControl |
str |
可选 |
参数解释: 响应中的Cache-Control头。指定对象被下载时的网页的缓存行为。 默认取值: 无 |
contentDisposition |
str |
可选 |
参数解释: 响应中的Content-Disposition头。指定对象被下载时的名称。 默认取值: 无 |
contentEncoding |
str |
可选 |
参数解释: 响应中的Content-Encoding头。指定对象被下载时的内容编码格式。 默认取值: 无 |
contentLanguage |
str |
可选 |
参数解释: 响应中的Content-Language头。指定对象被下载时的内容语言格式。 默认取值: 无 |
contentType |
str |
可选 |
参数解释: 响应中的Content-Type头。指定对象被下载时的文件类型。 默认取值: 无 |
expires |
str |
可选 |
参数解释: 响应中的Expires头。指定对象被下载时的网页的缓存过期时间。
注意:
此参数不用于设置对象过期时间,修改对象过期时间请参考设置对象过期时间(Python SDK)。 默认取值: 无 |
storageClass |
str |
可选 |
参数解释: 存储类型 取值范围: 指定对象的存储类型。 默认取值: 无 |
返回结果
类型 |
说明 |
---|---|
参数解释: 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时为空。该值根据调用接口的不同而不同,参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值: 无 |
代码样例
本示例用于修改/设置对象元数据。
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 |
from obs import SetObjectMetadataHeader from obs import ObsClient 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: # 设置对象自定义元数据 metadata = {'property1': 'property-value1', 'property2': 'property-value2'} # 设置对象附加头域 headers = SetObjectMetadataHeader() # 【可选】待上传对象的MIME类型 headers.contentType = "Your Content-Type" bucketName = "examplebucket" objectKey = "objectname" # 设置对象元数据 resp = obsClient.setObjectMetadata(bucketName, objectKey, metadata, headers) # 返回码为2xx时,接口调用成功,否则接口调用失败 if resp.status < 300: print('Set Object Metadata Succeeded') print('requestId:', resp.requestId) else: print('Set Object Metadata Failed') print('requestId:', resp.requestId) print('errorCode:', resp.errorCode) print('errorMessage:', resp.errorMessage) except: print('Set Object Metadata Failed') print(traceback.format_exc()) |