全部產品
Search

搜尋本產品

    Object Storage Service：Python儲存空間清單

    文件中心

    Object Storage Service：Python儲存空間清單

    更新時間：Oct 26, 2024

    本文介紹如何添加、查看、批量列舉和刪除儲存空間（Bucket）的清單（Inventory）配置。

    注意事項

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

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

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

    • 請確保您擁有調用添加、查看、列舉和刪除儲存空間清單配置的許可權。Bucket所有者預設擁有此類許可權，如果您無此類許可權，請先向Bucket所有者申請對應操作的許可權。

    • 單個Bucket最多隻能有1000條清單配置。

    • 配置清單的源Bucket與存放匯出的資訊清單檔所在的目標Bucket必須位於同一個Region。

    添加清單配置

    以下代碼用於為某個Bucket添加清單配置：

    # -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
from oss2.models import (InventoryConfiguration,
                         InventoryFilter,
                         InventorySchedule,
                         InventoryDestination,
                         InventoryBucketDestination,
                         INVENTORY_INCLUDED_OBJECT_VERSIONS_CURRENT,
                         INVENTORY_FREQUENCY_DAILY,
                         INVENTORY_FORMAT_CSV,
                         FIELD_SIZE,
                         FIELD_LAST_MODIFIED_DATE,
                         FIELD_STORAG_CLASS,
                         FIELD_ETAG,
                         FIELD_IS_MULTIPART_UPLOADED,
                         FIELD_ENCRYPTION_STATUS)

# 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數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"

# examplebucket填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "examplebucket", region=region)

# 填寫Bucket所有者授予的賬戶ID。例如：1283641033516515
account_id = 'yourtBucketDestinationAccountId'
# 填寫具有讀取源Bucket所有檔案和向目標Bucket寫入檔案許可權的角色名稱。例如：acs:ram::1283641033516515:role/AliyunOSSRole
role_arn = 'yourBucketDestinationRoleArn'
# 填寫存放清單結果的Bucket名稱。
dest_bucket_name = 'yourDestinationBucketName'

# 設定清單規則名稱。
inventory_id = "inventory1"

# 設定清單結果中包含的Object屬性。
optional_fields = [FIELD_SIZE, FIELD_LAST_MODIFIED_DATE, FIELD_STORAG_CLASS,
                   FIELD_ETAG, FIELD_IS_MULTIPART_UPLOADED, FIELD_ENCRYPTION_STATUS]

# 建立存放資訊清單檔的目標Bucket配置。
bucket_destination = InventoryBucketDestination(
    # 目標Bucket的使用者accountId。
    account_id=account_id,
    # 目標Bucket的roleArn。
    role_arn=role_arn,
    # 目標Bucket的名稱。
    bucket=dest_bucket_name,
    # 指定清單格式。
    inventory_format=INVENTORY_FORMAT_CSV,
    # 清單結果的儲存路徑首碼。
    prefix='destination-prefix',
    # 如果需要使用KMS加密清單，請參考如下設定。
    # sse_kms_encryption=InventoryServerSideEncryptionKMS("test-kms-id"),
    # 如果需要使用OSS服務端加密清單，請參考如下設定。
    # sse_oss_encryption=InventoryServerSideEncryptionOSS()
)

# 建立清單配置。
inventory_configuration = InventoryConfiguration(
    # 設定清單的配置id。
    inventory_id=inventory_id,
    # 清單配置是否啟用的標識, true或false。
    is_enabled=True,
    # 設定清單的產生計劃，以下樣本為每天一次。其中，WEEKLY對應每周一次，DAILY對應每天一次。
    inventory_schedule=InventorySchedule(frequency=INVENTORY_FREQUENCY_DAILY),
    # 設定清單中包含的object的版本為目前的版本。如果設定為INVENTORY_INCLUDED_OBJECT_VERSIONS_ALL則表示object的所有版本，在版本控制狀態下生效。
    included_object_versions=INVENTORY_INCLUDED_OBJECT_VERSIONS_CURRENT,
    # 設定清單清篩選object的首碼。
    # inventory_filter=InventoryFilter(prefix="obj-prefix"),
    # 設定清單清篩選條件。假如篩選檔案最後修改時間的起始時間戳記為1637883649，
    inventory_filter=InventoryFilter(
        # 篩選規則的匹配首碼。
        "obj-prefix",
        # 篩選檔案最後修改時間的起始時間戳記，單位為秒。
        1637883649,
        # 篩選檔案最後修改時間的終止時間戳記，單位為秒。
        1638347592,
        # 篩選檔案的最小大小，單位為B。
        1024,
        # 篩選檔案的最大大小，單位為B。
        1048576,
        # 篩選檔案的儲存類型，支援指定多種儲存類型。
        'Standard,IA'),
    # 設定清單中包含的object屬性。
    optional_fields=optional_fields, 
    inventory_destination=InventoryDestination(bucket_destination=bucket_destination))

# 上傳清單配置。
result = bucket.put_bucket_inventory_configuration(inventory_configuration)
print(result.status)

    查看清單配置

    以下代碼用於查看某個Bucket的清單配置：

    # -*- coding: utf-8 -*-

import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
import os

# 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數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"

# examplebucket填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "examplebucket", region=region)

# 填寫清單規則名稱。
inventory_id = "inventory1"

# 擷取清單配置。
result = bucket.get_bucket_inventory_configuration(inventory_id=inventory_id)

# 列印清單配置資訊。
print('======inventory configuration======')
print('inventory_id', result.inventory_id)
print('is_enabled', result.is_enabled)
print('frequency', result.inventory_schedule.frequency)
print('included_object_versions', result.included_object_versions)
print('inventory_filter prefix', result.inventory_filter.prefix)
print('fields', result.optional_fields)
bucket_destin = result.inventory_destination.bucket_destination
print('===bucket destination===')
print('account_id', bucket_destin.account_id)
print('role_arn', bucket_destin.role_arn)
print('bucket', bucket_destin.bucket)
print('format', bucket_destin.inventory_format)
print('prefix', bucket_destin.prefix)
if bucket_destin.sse_kms_encryption is not None:
    print('server side encryption by kms, key id:', bucket_destin.sse_kms_encryption.key_id)
elif bucket_destin.sse_oss_encryption is not None:
    print('server side encryption by oss.')

    批量列舉清單配置

    說明

    單次請求最多可擷取100條清單配置項內容。若需擷取超過100條清單配置項，則需發送多次請求，並保留相應的Token，作為下一次請求的參數。

    以下代碼用於批量列舉某個Bucket的清單配置：

    # -*- coding: utf-8 -*-

import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
import os

# 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數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"

# examplebucket填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "examplebucket", region=region)

# 列印清單配置資訊。
def print_inventory_configuration(configuration):
    print('======inventory configuration======')
    print('inventory_id', configuration.inventory_id)
    print('is_enabled', configuration.is_enabled)
    print('frequency', configuration.inventory_schedule.frequency)
    print('included_object_versions', configuration.included_object_versions)
    print('inventory_filter prefix', configuration.inventory_filter.prefix)
    print('fields', configuration.optional_fields)
    bucket_destin = configuration.inventory_destination.bucket_destination
    print('===bucket destination===')
    print('account_id', bucket_destin.account_id)
    print('role_arn', bucket_destin.role_arn)
    print('bucket', bucket_destin.bucket)
    print('format', bucket_destin.inventory_format)
    print('prefix', bucket_destin.prefix)
    if bucket_destin.sse_kms_encryption is not None:
        print('server side encryption by kms, key id:', bucket_destin.sse_kms_encryption.key_id)
    elif bucket_destin.sse_oss_encryption is not None:
        print('server side encryption by oss.')

# 列舉所有的清單配置。
# 如果存在超過100條配置，列舉結果將會分頁，分頁資訊儲存在class: <oss2.models.ListInventoryConfigurationResult>中。
continuation_token = None
while 1:
    result = bucket.list_bucket_inventory_configurations(continuation_token=continuation_token)
    # 本次列舉結果是否分頁。
    print('is truncated', result.is_truncated)
    # 本次列舉攜帶的token。
    print('continuaiton_token', result.continuaiton_token)
    # 下次列舉需要攜帶的token。
    print('next_continuation_token', result.next_continuation_token)

    # 列印清單配置資訊。
    for inventory_config in result.inventory_configurations:
        print_inventory_configuration(inventory_config)

    # 如果本次列舉為分頁列舉，則繼續列舉，且需要攜帶分頁token。
    if result.is_truncated:
        continuation_token = result.next_continuation_token
    else:
         break

    刪除清單配置

    以下代碼用於刪除某個Bucket的清單配置：

    # -*- coding: utf-8 -*-

import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
import os

# 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數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"

# examplebucket填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "examplebucket", region=region)

# 填寫清單規則名稱。
inventory_id = "inventory1"

# 刪除清單配置。
bucket.delete_bucket_inventory_configuration(inventory_id)

    相關文檔