Object Storage Service:Resumable download (C# SDK V1)

注意事項

• このトピックでは、中国 (杭州) リージョンのパブリックエンドポイントを使用します。OSS と同じリージョンにある他の Alibaba Cloud サービスから OSS にアクセスする場合は、内部エンドポイントを使用してください。OSS のリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。

• このトピックでは、OSS エンドポイントを使用して OSSClient インスタンスを作成します。カスタムドメイン名またはセキュリティトークンサービス (STS) を使用して OSSClient インスタンスを作成する場合は、「初期化」をご参照ください。

• 再開可能なダウンロードを実行するには、oss:GetObject 権限が必要です。詳細については、「RAM ユーザーへのカスタムポリシーのアタッチ」をご参照ください。

サンプルコード

次のコードは、再開可能なダウンロードを実行する方法の例を示しています：

using Aliyun.OSS;
using Aliyun.OSS.Common;

// yourEndpoint を、バケットが所在するリージョンのエンドポイントに設定します。 たとえば、バケットが中国 (杭州) リージョンにある場合、エンドポイントを 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";
// オブジェクトを examplefile.txt という名前のローカルファイルにダウンロードし、指定されたローカルパス (D:\\localpath) に保存します。 ローカルファイルが存在する場合、上書きされます。 ローカルファイルが存在しない場合は、作成されます。
// ローカルパスを指定しない場合、ダウンロードされたファイルはサンプルプログラムが配置されているプロジェクトのローカルパスに保存されます。
var downloadFilename = "D:\\localpath\\examplefile.txt";
// ブレークポイントレコードファイルの完全なパスを指定します。 例：D:\\localpath\\examplefile.txt.dcp。
// ブレークポイントレコードファイルは、ダウンロードが中断され、ブレークポイントレコードファイルが生成された場合にのみ指定する必要があります。 ダウンロードが完了すると、このファイルは削除されます。
var checkpointDir = "D:\\localpath\\examplefile.txt.dcp";
// バケットが所在するリージョンを指定します。 たとえば、バケットが中国 (杭州) リージョンにある場合、リージョンを cn-hangzhou に設定します。
const string region = "cn-hangzhou";

// ClientConfiguration インスタンスを作成し、必要に応じてデフォルトのパラメーターを変更します。
var conf = new ClientConfiguration();

// 署名バージョンを V4 に設定します。
conf.SignatureVersion = SignatureVersion.V4;

// OssClient インスタンスを作成します。
var client = new OssClient(endpoint, accessKeyId, accessKeySecret, conf);
client.SetRegion(region);
try
{
    // DownloadObjectRequest に複数のパラメーターを設定します。
    DownloadObjectRequest request = new DownloadObjectRequest(bucketName, objectName, downloadFilename)
    {
        // ダウンロードする各パートのサイズをバイト単位で指定します。
        PartSize = 8 * 1024 * 1024,
        // 同時実行スレッド数を指定します。
        ParallelThreadCount = 3,
        // checkpointDir は、再開可能なダウンロードの進行状況を保存するために使用されます。 パートのダウンロードに失敗した場合、再試行時に記録されたブレークポイントからダウンロードが再開されます。 checkpointDir が null に設定されている場合、再開可能なダウンロード機能は無効になります。 失敗するたびに、ダウンロードは最初から再開されます。
        CheckpointDir = checkpointDir,
    };
    // 再開可能なダウンロードを実行します。
    client.ResumableDownloadObject(request);
    Console.WriteLine("オブジェクト {0} の再開可能なダウンロードに成功しました", objectName);
}
catch (OssException ex)
{
    Console.WriteLine("エラーコード：{0}、エラー情報：{1} で失敗しました。 \nRequestID:{2}\tHostID:{3}",
        ex.ErrorCode, ex.Message, ex.RequestId, ex.HostId);
}
catch (Exception ex)
{
    Console.WriteLine("エラー情報：{0} で失敗しました", ex.Message);
}

関連ドキュメント

再開可能なダウンロードの API 操作の詳細については、「GetObject」をご参照ください。