Object Storage Service：Python管理檔案中繼資料

Object Storage Service儲存的檔案（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(simplifiedmeta.headers['Last-Modified'])
# 擷取檔案大小。
print(simplifiedmeta.headers['Content-Length'])
# 擷取檔案的ETag值。
print(simplifiedmeta.headers['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(objectmeta.headers['Content-Type'])
print(objectmeta.headers['Last-Modified'])
print(objectmeta.headers['x-oss-object-type'])

相關文檔

• 關於檔案中繼資料的更多內容，請參見管理檔案中繼資料。

• 關於在簡單上傳過程中設定檔案中繼資料的API介面說明，請參見PutObject。

• 關於擷取檔案中繼資料的API介面說明，請參見GetObjectMeta和HeadObject。