ネットワークが不安定な場合やその他の例外が発生した場合、大きなオブジェクトのダウンロードに失敗することがあります。 場合によっては、複数回試行してもオブジェクトのダウンロードに失敗することがあります。 この問題を解決するために、Object Storage Service (OSS) は再開可能なダウンロード機能を提供しています。 再開可能ダウンロードでは、OSSはオブジェクトを複数のパーツに分割し、各パーツを個別にダウンロードします。 すべてのパーツがダウンロードされた後、OSSはパーツを完全なオブジェクトに結合します。
使用上の注意
このトピックでは、中国 (杭州) リージョンのパブリックエンドポイントを使用します。 OSSと同じリージョンにある他のAlibaba Cloudサービスを使用してOSSにアクセスする場合は、内部エンドポイントを使用します。 OSSでサポートされているリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。
このトピックでは、OSSエンドポイントを使用してOSSClientインスタンスを作成します。 カスタムドメイン名またはSTS (Security Token Service) を使用してOSSClientインスタンスを作成する場合は、「初期化」をご参照ください。
再開可能ダウンロードを使用するには、
oss:GetObject
権限が必要です。 詳細については、「RAMユーザーへのカスタムポリシーのアタッチ」をご参照ください。
サンプルコード
次のコードは、再開可能なダウンロードを実行する方法の例を示しています。
Aliyun.OSSを使用した
Aliyun.OSS.Common; を使用
// バケットが配置されているリージョンのエンドポイントを指定します。 たとえば、バケットが中国 (杭州) リージョンにある場合、エンドポイントをhttps://oss-cn-hangzhou.aliyuncs.comに設定します。
var endpoint = "yourEndpoint";
// 環境変数からアクセス資格情報を取得します。 サンプルコードを実行する前に、OSS_ACCESS_KEY_IDおよびOSS_ACCESS_KEY_SECRET環境変数が設定されていることを確認してください。
var accessKeyId = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_ID");
var accessKeySecret = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET");
// バケットの名前を指定します。 例: examplebucket.
var bucketName = "examplebucket";
// オブジェクトのフルパスを指定します。 バケット名をフルパスに含めないでください。 例: exampledir/exampleobject.txt。
var objectName = "exampleobject.txt";
// オブジェクトをD :\\ localpathにダウンロードします。 オブジェクトがダウンロードされると、ローカルファイルの名前はexamplefile.txtになります。 同じ名前のファイルが既に存在する場合、ダウンロードされたオブジェクトはファイルを上書きします。 それ以外の場合、ダウンロードされたオブジェクトはパスに保存されます。
// ダウンロードしたオブジェクトのパスを指定しない場合、ダウンロードしたオブジェクトはサンプルプログラムが属するプロジェクトのパスに保存されます。
var downloadFilename = "D :\\ localpath\\examplefile.txt";
// チェックポイントファイルのフルパスを指定します。 例: D :\\ localpath\\examplefile.txt.dcp。
// ダウンロードが中断されると、チェックポイントファイルが生成されます。 ダウンロードタスクを再開する場合は、チェックポイントファイルのフルパスを指定する必要があります。 オブジェクトがダウンロードされた後、チェックポイントファイルは削除されます。
var checkpointDir = "D :\\ localpath\\examplefile.txt.dcp";
// OSSClientインスタンスを作成します。
var client = new OssClient (エンドポイント、accessKeyId、accessKeySecret);
トライ
{
// DownloadObjectRequestを使用して複数のパラメーターを設定します。
DownloadObjectRequest request = new DownloadObjectRequest(bucketName, objectName, downloadFilename)
{
// ダウンロードする各パーツのサイズを指定します。 単位:バイト
PartSize = 8 * 1024 * 1024,
// 同時スレッドの数を指定します。
ParallelThreadCount = 3,
// checkpointDirは、再開可能なダウンロードの進行状況に関する情報を格納するために使用されるファイルです。 パーツのダウンロードに失敗した場合は、checkpointDirファイルに記録されている進行状況に基づいてダウンロードタスクを再開できます。 checkpointDirをnullに設定すると、再開可能なダウンロードは有効にならず、ダウンロードに失敗した場合、オブジェクトは再度ダウンロードされます。
CheckpointDir = checkpointDir,
};
// Start the resumable download.
client.ResumableDownloadObject(request);
Console.WriteLine("Resumable download object:{0} successed", objectName);
}
キャッチ (OssException ex)
{
Console.WriteLine("Failed with error code: {0}; エラー情報: {1} 。 \nRequestID:{2}\tHostID:{3}"、
ex.ErrorCode, ex.Message, ex.RequestId, ex.HostId);
}
キャッチ (例外ex)
{
Console.WriteLine("Failed with error info: {0}" 、メッセージなど);
}
参考資料
再開可能ダウンロードの実行に使用されるAPI操作の詳細については、「GetObject」をご参照ください。