Object Storage Service：Python刪除檔案

注意事項

• 本文以華東1（杭州）外網Endpoint為例。如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS，請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係，請參見訪問網域名稱和資料中心。

• 本文以從環境變數讀取存取憑證為例。如何配置訪問憑證，請參見配置訪問憑證。

• 本文以OSS網域名稱建立OSSClient為例。如果您希望通過自訂網域名、STS等方式建立OSSClient，請參見初始化。

• 要刪除檔案，您必須有oss:DeleteObject許可權。具體操作，請參見為RAM使用者授權自訂的權限原則。

版本控制下的刪除行為

版本控制下的刪除行為說明如下：

• 未指定versionId（臨時刪除）：

  如果在未指定versionId的情況下執行刪除操作時，預設不會刪除Object的目前的版本，而是對目前的版本插入刪除標記（Delete Marker）。當執行GetObject操作時，OSS會檢測到目前的版本為刪除標記，並返回404 Not Found。此外，響應中會返回header：x-oss-delete-marker = true以及新產生的刪除標記的版本號碼x-oss-version-id。

  x-oss-delete-marker的值為true，表示與返回的x-oss-version-id對應的版本為刪除標記。

• 指定versionId（永久刪除）：

  如果在指定versionId的情況下執行刪除操作時，OSS會根據params中指定的versionId參數永久刪除該版本。如果要刪除ID為“null”的版本，請在params參數中添加params['versionId'] = “null”，OSS將“null”字串當成“null”的versionId，從而刪除versionId為“null”的Object。

刪除單個檔案

以下提供了永久刪除及臨時刪除單個Object的樣本。

• 永久刪除

  以下代碼用於指定versionId對Object進行永久刪除：

  # -*- coding: utf-8 -*-
  import os
  import oss2
  from oss2.credentials import EnvironmentVariableCredentialsProvider
  # 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
  auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())
  # 填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
  # yourBucketName填寫儲存空間名稱。
  bucket = oss2.Bucket(auth, 'https://oss-cn-hangzhou.aliyuncs.com', 'yourBucketName')
  # yourObjectName填寫不包含Bucket名稱在內的Object的完整路徑，例如example/test.txt。
  object_name = 'yourObjectName'
  
  # 指定Object的versionId，也可以是刪除標記的versionId。
  params = dict()
  params['versionId'] = 'yourObjectVersionIdOrDeleteMarkerVersionId'
  
  # 刪除指定versionId的Object或指定versionId的刪除標記關聯的Object。
  result = bucket.delete_object(object_name, params=params)
  print("delete object name: ", object_name)
  # 如果指定的是Object的versionId，則返回的delete_marker為None且返回的versionId為指定Object的versionId。
  # 如果指定的是刪除標記的versionId，則返回的delete_marker為True且返回的versionId為指定刪除標記的versionId。
  if result.delete_marker:
      print("delete del-marker versionid: ",result.versionid)
  else:
      print("delete object versionid:", result.versionid)

• 臨時刪除

  以下代碼用於不指定versionId對Object進行臨時刪除：

  # -*- coding: utf-8 -*-
  import os
  import oss2
  from oss2.credentials import EnvironmentVariableCredentialsProvider
  # 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
  auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())
  # 填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
  # yourBucketName填寫儲存空間名稱。
  bucket = oss2.Bucket(auth, 'https://oss-cn-hangzhou.aliyuncs.com', 'yourBucketName')
  # yourObjectName填寫不包含Bucket名稱在內的Object的完整路徑，例如example/test.txt。
  object_name = 'yourObjectName'
  
  # 不指定versionId對Object進行臨時刪除，此操作會為Object添加刪除標記。
  result = bucket.delete_object(object_name)
  # 查看刪除標記。
  print("delete marker: ", result.delete_marker)
  # 查看返回刪除標記的versionId。
  print("delete marker versionid: ", result.versionid)

刪除多個檔案

以下提供了永久刪除以及臨時刪除多個Object的樣本。

• 永久刪除

  以下代碼用於指定versionId對多個Object及刪除標記進行永久刪除：

  # -*- coding: utf-8 -*-
  import os
  import oss2
  from oss2.credentials import EnvironmentVariableCredentialsProvider
  from oss2.models import BatchDeleteObjectVersion
  from oss2.models import BatchDeleteObjectVersionList
  # 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
  auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())
  # 填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
  # yourBucketName填寫儲存空間名稱。
  bucket = oss2.Bucket(auth, 'https://oss-cn-hangzhou.aliyuncs.com', 'yourBucketName')
  
  version_list = BatchDeleteObjectVersionList()
  # 可以傳入Object或者刪除標記的versionId。
  obj1_versionid = 'yourObject1VersionId'
  obj1_del_marker_versionid = 'yourObject1DelMarkerVersionId'
  obj2_versionid = 'yourObject2VersionId'
  obj2_del_marker_versionid = 'yourObject2DelMarkerVersionId'
  version_list.append(BatchDeleteObjectVersion(key='yourObject1Name', versionid=obj1_versionid))
  version_list.append(BatchDeleteObjectVersion(key='yourObject1Name', versionid=obj1_del_marker_versionid))
  version_list.append(BatchDeleteObjectVersion(key='yourObject2Name', versionid=obj2_versionid))
  version_list.append(BatchDeleteObjectVersion(key='yourObject2Name', versionid=obj2_del_marker_versionid))
  
  # 大量刪除指定versionId的Object或刪除標記。
  result = bucket.delete_object_versions(version_list)
  # 查看被刪除Object或刪除標記的versionId。
  for del_version in result.delete_versions:
      print('del object name:', del_version.key)
      # 查看刪除的是否是刪除標記。
      print('Is del marker:', del_version.delete_marker)
      # 如果是刪除標記，則列印刪除的刪除標記的versionId，否則列印刪除Object的versionId。
      if del_version.delete_marker :
          print('del object del_marker.versionid', del_version.delete_marker_versionid)
      else:
          print('del object versionid:', del_version.versionid)

• 臨時刪除

  以下代碼用於不指定versionId對多個Object進行臨時刪除：

  # -*- coding: utf-8 -*-
  import os
  import oss2
  from oss2.credentials import EnvironmentVariableCredentialsProvider
  from oss2.models import BatchDeleteObjectVersion
  from oss2.models import BatchDeleteObjectVersionList
  # 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
  auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())
  # 填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
  # yourBucketName填寫儲存空間名稱。
  bucket = oss2.Bucket(auth, 'https://oss-cn-hangzhou.aliyuncs.com', 'yourBucketName')
  
  
  key_list = ['yourObject1Name', 'yourObject2Name']
  # 執行不指定versionId的刪除操作後，將為Object添加刪除標記。
  result = bucket.batch_delete_objects(key_list)
  for del_version in result.delete_versions:
      print('key name:', del_version.key)
      # 列印返回的刪除標記。
      print('Is del marker:', del_version.delete_marker)
      print('key del_marker.versionid', del_version.delete_marker_versionid)

刪除指定首碼（prefix）的檔案

以下代碼用於刪除指定首碼的檔案：

# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())
# 填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
# yourBucketName填寫儲存空間名稱。
bucket = oss2.Bucket(auth, 'https://oss-cn-hangzhou.aliyuncs.com', 'yourBucketName')
prefix = "yourKeyPrefix"

# 列舉所有指定首碼檔案的versionId並刪除這些檔案。
next_key_marker = None
next_versionid_marker = None
while True:
    result = bucket.list_object_versions(prefix=prefix, key_marker=next_key_marker, versionid_marker=next_versionid_marker)

    for version_info in result.versions:
        bucket.delete_object(version_info.key, params={'versionId': version_info.versionid})

    for del_marker_info in result.delete_marker:
        bucket.delete_object(del_marker_info.key, params={'versionId': del_marker_info.versionid})

    is_truncated = result.is_truncated

    if is_truncated:
        next_key_marker = result.next_key_marker
        next_versionid_marker = result.next_versionid_marker
    else:
        break

相關文檔

• 關於刪除單個檔案的API介面說明，請參見DeleteObject。

• 關於刪除多個檔案的API介面說明，請參見DeleteMultipleObjects。