ストリーミングダウンロードを使用すると、オブジェクトをストリーム単位でダウンロードできます。 大きなオブジェクトをダウンロードしたい場合、またはダウンロードの完了に長時間を要する場合は、ストリーミングダウンロードを実行してオブジェクトを増分単位でダウンロードできます。
使用上の注意
このトピックでは、中国 (杭州) リージョンのパブリックエンドポイントを使用します。 OSSと同じリージョンにある他のAlibaba CloudサービスからOSSにアクセスする場合は、内部エンドポイントを使用します。 OSSリージョンとエンドポイントの詳細については、「リージョン、エンドポイント、オープンポート」をご参照ください。
このトピックでは、OSSエンドポイントを使用してOSSClientインスタンスを作成します。 カスタムドメイン名またはSTS (Security Token Service) を使用してOSSClientインスタンスを作成する場合は、「初期化」をご参照ください。
ストリーミングダウンロードを使用するには、
oss:GetObject権限が必要です。 詳細については、「RAMユーザーへのカスタムポリシーのアタッチ」をご参照ください。
サンプルコード
次のサンプルコードは、ストリーミングダウンロードを実行して、examplebucketという名前のバケットからexampleobject.txtという名前のオブジェクトをダウンロードする方法の例を示しています。
# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# Create a server object.
# Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())
# Specify the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com.
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"
# Specify the ID of the region that maps to the endpoint. Example: cn-hangzhou. This parameter is required if you use the signature algorithm V4.
region = "cn-hangzhou"
# Specify the name of your bucket.
bucket = oss2.Bucket(auth, endpoint, "yourBucketName", region=region)
# The value returned by bucket.get_object is a file-like object that can be iterated.
# Specify the full path of the object. Do not include the bucket name in the full path of the object.
object_stream = bucket.get_object('exampleobject.txt')
print(object_stream.read())
# You must call the read() operation to read the object from the stream returned by get_object before you can calculate the CRC-64 value of the object.
if object_stream.client_crc != object_stream.server_crc:
print("The CRC checksum between client and server is inconsistent!")次のサンプルコードは、exampleobject.txtという名前のオブジェクトのデータを、D:\localpathディレクトリのexamplefile.txtという名前のファイルとしてストリームからダウンロードする方法の例を示しています。
import shutil
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# Create a server object.
# Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())
# Specify the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com.
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"
# Specify the ID of the region that maps to the endpoint. Example: cn-hangzhou. This parameter is required if you use the signature algorithm V4.
region = "cn-hangzhou"
# Specify the name of your bucket.
bucket = oss2.Bucket(auth, endpoint, "yourBucketName", region=region)
# object_stream is a file-like object. You can use the shutil.copyfileobj method to download the data from a stream to the local file.
# Specify the full path of the object. Do not include the bucket name in the full path of the object.
object_stream = bucket.get_object('exampleobject.txt')
# Download the object as a local file in the specified path. If a file that has the same name already exists in the specified path, the downloaded object overwrites the file. Otherwise, the downloaded file is saved in the path.
# If you do not specify a path for the downloaded object, the downloaded object is saved to the path of the project to which the sample program belongs.
with open('D:\\localpath\\examplefile.txt', 'wb') as local_fileobj:
shutil.copyfileobj(object_stream, local_fileobj)次のサンプルコードは、exampleobject.txtという名前のオブジェクトのデータをストリームからexampleobjectnew.txtという名前のオブジェクトにコピーする方法の例を示しています。
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# Create a server object.
# Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())
# Specify the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com.
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"
# Specify the ID of the region that maps to the endpoint. Example: cn-hangzhou. This parameter is required if you use the signature algorithm V4.
region = "cn-hangzhou"
# Specify the name of your bucket.
bucket = oss2.Bucket(auth, endpoint, "yourBucketName", region=region)
# object_stream is an iterable object. You can copy the data of the object from a stream to another object in the same bucket.
# Specify the full path of the object. Do not include the bucket name in the full path of the object.
object_stream = bucket.get_object('exampleobject.txt')
# Specify the full path of the destination object. Do not include the bucket name in the full path of the object.
bucket.put_object('exampleobjectnew.txt', object_stream)