Python管理文件元数据

对象存储OSS存储的文件（Object）信息包含Key、Data和Object Meta。Object Meta是对文件的属性描述，包括HTTP标准属性（HTTP Header）和用户自定义元数据（User Meta）两种。您可以通过设置HTTP标准属性来自定义HTTP请求的策略，例如文件（Object）缓存策略、强制下载策略等。您还可以通过设置用户自定义元数据来标识Object的用途或属性等。

注意事项

• 本文以华东1（杭州）外网Endpoint为例。如果您希望通过与OSS同地域的其他阿里云产品访问OSS，请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系，请参见OSS地域和访问域名。

• 本文以OSS域名新建OSSClient为例。如果您希望通过自定义域名、STS等方式新建OSSClient，请参见初始化。

• 要设置文件元数据，您必须具有oss:PutObject权限；要获取文件元数据，您必须具有oss:GetObject权限。具体操作，请参见为RAM用户授权自定义的权限策略。

设置HTTP header

以下代码用于为examplebucket存储空间中exampledir目录下exampleobject.txt文件设置HTTP header。

# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider

# 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())

# 填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"

# 填写Endpoint对应的Region信息，例如cn-hangzhou。注意，v4签名下，必须填写该参数
region = "cn-hangzhou"

# yourBucketName填写存储空间名称。
bucket = oss2.Bucket(auth, endpoint, "yourBucketName", region=region)

# 填写Object完整路径，例如exampledir/exampleobject.txt。Object完整路径中不能包含Bucket名称。
object_name = 'exampledir/exampleobject.txt'
# 填写待上传的字符串。
content = '{"age": 1}'
# 设置HTTP header，例如HTTP header的名称为Content-Type，值为'application/json; charset=utf-8'。
bucket.put_object(object_name, content, headers={'Content-Type': 'application/json; charset=utf-8'})

设置自定义元数据

您可以自定义文件的元数据来对文件进行描述。

以下代码用于为examplebucket存储空间中exampledir目录下exampleobject.txt文件设置自定义元数据。

# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider

# 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())

# 填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"

# 填写Endpoint对应的Region信息，例如cn-hangzhou。注意，v4签名下，必须填写该参数
region = "cn-hangzhou"

# yourBucketName填写存储空间名称。
bucket = oss2.Bucket(auth, endpoint, "yourBucketName", region=region)

# 填写Object完整路径，例如exampledir/exampleobject.txt。Object完整路径中不能包含Bucket名称。
object_name = 'exampledir/exampleobject.txt'
# 填写待上传字符串。
content = 'a novel'

# 设置自定义元数据，自定义元数据必须以x-oss-meta-为前缀，例如自定义元数据的名称为x-oss-meta-author，值为'O. Henry'。
bucket.put_object(object_name, content, headers={'x-oss-meta-author': 'O. Henry', 'Content-Type': 'application/json; charset=utf-8'})

修改文件元数据

以下代码用于修改examplebucket存储空间中exampledir目录下exampleobject.txt文件的元数据。

# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider

# 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())

# 填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"

# 填写Endpoint对应的Region信息，例如cn-hangzhou。注意，v4签名下，必须填写该参数
region = "cn-hangzhou"

# yourBucketName填写存储空间名称。
bucket = oss2.Bucket(auth, endpoint, "yourBucketName", region=region)

# 填写Object完整路径，例如exampledir/exampleobject.txt。Object完整路径中不能包含Bucket名称。
object_name = 'exampledir/exampleobject.txt'
# 修改文件元数据。
bucket.update_object_meta(object_name, {'x-oss-meta-author': 'O. Henry'})
# 每次调用bucket.update_object_meta都会清空用户自定义元数据，重新写入。
bucket.update_object_meta(object_name, {'Content-Type': 'text/plain'})

获取文件元数据

您可以通过SDK提供的方法获取文件元数据。

以下代码用于获取examplebucket存储空间中exampledir目录下exampleobject.txt文件的元数据。

# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider

# 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())

# 填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"

# 填写Endpoint对应的Region信息，例如cn-hangzhou。注意，v4签名下，必须填写该参数
region = "cn-hangzhou"

# yourBucketName填写存储空间名称。
bucket = oss2.Bucket(auth, endpoint, "yourBucketName", region=region)

# 填写Object完整路径，例如exampledir/exampleobject.txt。Object完整路径中不能包含Bucket名称。
object_name = 'exampledir/exampleobject.txt'

# 通过get_object_meta方法获取文件的部分元数据。
simplifiedmeta = bucket.get_object_meta(object_name)
# 打印文件的部分元数据
print("Last-Modified: " + simplifiedmeta.headers['Last-Modified'])  # 获取文件的最后一次修改时间
print("Content-Length: " + simplifiedmeta.headers['Content-Length'])  # 获取文件大小
print("ETag: " + simplifiedmeta.headers['ETag'])  # 获取文件的ETag值
# 开启访问跟踪功能后，用于获取包含最后一次访问时间（x-oss-last-access-time）在内的文件元数据。仅Python SDK 2.16.1及以上版本支持获取x-oss-last-access-time。
# print(simplifiedmeta.headers['x-oss-last-access-time'])

# 通过head_object方法获取文件的全部元数据。
objectmeta = bucket.head_object(object_name)
# 此处以打印文件的部分元数据为例介绍。如果需要打印文件的其他元数据，请自行添加。
# 打印文件的部分元数据
print("Content-Type: " + objectmeta.headers['Content-Type'])  # 获取文件的MIME类型
print("Content-MD5: " + objectmeta.headers['Content-MD5'])  # 获取文件的MD5校验值
print("x-oss-storage-class: " + objectmeta.headers['x-oss-storage-class'])  # 获取文件的存储类别
print("x-oss-hash-crc64ecma: " + objectmeta.headers['x-oss-hash-crc64ecma'])  # 获取文件的CRC64-ECMA校验值


# 打印所有的 header字段
# 如果需要打印所有 header 字段，请取消注释以下代码
# print("\n所有headers:")
# for key, value in objectmeta.headers.items():
#     print(f"{key}: {value}")

相关文档

• 关于文件元数据的更多内容，请参见管理文件元数据。

• 关于在简单上传过程中设置文件元数据的API接口说明，请参见PutObject。

• 关于获取文件元数据的API接口说明，请参见GetObjectMeta和HeadObject。