# 修改对象元数据(Python SDK) #### 功能说明 元数据（Metadata）为描述对象属性的信息，是一组名称值对，用作对象管理的一部分。 当前仅支持系统定义的元数据。 系统定义的元数据又分为两种类别：系统控制和用户控制。如Last-Modified日期等数据由系统控制，不可修改；如为对象配置的ContentLanguage，用户可以通过接口进行修改。 可以通过本接口添加、修改或删除桶中已经上传的对象的元数据。 #### 接口约束 - 您必须是桶拥有者或拥有设置对象元数据的权限，才能设置对象元数据。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:ModifyObjectMetaData权限，如果使用桶策略则需授予ModifyObjectMetaData权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[配置对象策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0075.html)。 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 - 当桶开启多版本控制时，最新版本的对象支持设置元数据，历史版本的对象不支持设置元数据。 - 对于存储类别为归档或深度归档存储的对象，不能对其设置对象的元数据。 #### 方法定义 ``` ObsClient.setObjectMetadata(bucketName, objectKey, metadata, headers, versionId, extensionHeaders) ``` #### 请求参数 表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的字符串。 **默认取值：** 无 | | 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 | [SetObjectMetadataHeader] | 可选 | **参数解释：** 设置对象元数据的头域，用于设置对象元数据的基本信息，详见[SetObjectMetadataHeader]。 | | versionId | str | 可选 | **参数解释：** 对象的版本号。例如：G001117FCE89978B0000401205D5DC9A。 **取值范围：** 长度为32的字符串。 **默认取值：** 无 | | extensionHeaders | dict | 可选 | **参数解释：** 接口的拓展头域。 **取值范围：** 参考[自定义头域](https://support.huaweicloud.com/sdk-python-devg-obs/obs_22_1305.html)。 **默认取值：** 无 | 表2SetObjectMetadataHeader | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | 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"中。 **约束限制：** - 必须以"/"、"http://"或"https://"开头，长度不超过2KB。 - OBS仅支持为桶根目录下的对象设置重定向，不支持为桶中文件夹下的对象设置重定向。 **默认取值：** 无 | | 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)](https://support.huaweicloud.com/sdk-python-devg-obs/obs_22_1704.html)。 **默认取值：** 无 | | storageClass | str | 可选 | **参数解释：** 存储类型 **取值范围：** 指定对象的[存储类型]。 **默认取值：** 无 | 表3StorageClass | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | STANDARD | 标准存储 | **参数解释：** 标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（\<1MB），且需要频繁访问数据的业务场景。 | | WARM | 低频访问存储 | **参数解释：** 低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。 | | COLD | 归档存储 | **参数解释：** 归档存储适用于很少访问（平均一年访问一次）数据的业务场景。 | | DEEP_ARCHIVE | 深度归档存储 | **参数解释：** 深度归档存储适用于长期不访问（平均几年访问一次）数据的业务场景。 | #### 返回结果 表4返回结果 | **类型** | **说明** | |:---|:---| | [GetResult] | **参数解释：** SDK公共结果对象。 | 表5GetResult | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | status | int | **参数解释：** HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 **默认取值：** 无 | | 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时为空。该值根据调用接口的不同而不同，参见"桶相关接口"章节和"对象相关接口"章节的详细描述。 **默认取值：** 无 | #### 代码样例 本示例用于修改/设置对象元数据。 ``` import os import traceback from obs import ObsClient from obs import SetObjectMetadataHeader # 推荐通过环境变量获取AK/SK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险 # 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html ak = os.getenv("AccessKeyID") sk = os.getenv("SecretAccessKey") # 如需使用临时AK/SK和SecurityToken访问OBS，则同样推荐通过环境变量获取 # security_token = os.getenv("SecurityToken") # server填写Bucket对应的Endpoint，这里以华北-北京四为例，其他地区请按实际情况填写 server = "https://obs.cn-north-4.myhuaweicloud.com" # 创建obsClient实例 # 如果使用临时AK/SK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值 obs_client = 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" bucket_name = "examplebucket" object_key = "objectname" # 设置对象元数据 resp = obs_client.setObjectMetadata(bucket_name, object_key, 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 Exception: print('Set Object Metadata Failed') print(traceback.format_exc()) ``` #### 相关链接 - 关于添加、修改或删除桶中已经上传的对象的元数据的API说明，请参见[修改对象元数据](https://support.huaweicloud.com/api-obs/obs_04_0091.html)。 - 更多关于设置对象元数据的示例代码，请参见[Github示例](https://github.com/huaweicloud/huaweicloud-sdk-python-obs/blob/master/examples/object_operations_sample.py)。 - 获取对象元数据过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。