サイズの大きいファイルのダウンロードは、不安定なネットワークやプログラムの例外が原因で失敗することがあります。複数回再試行してもダウンロードが失敗することもあります。この問題を解決するために、Object Storage Service (OSS) は再開可能なダウンロード機能を提供しています。再開可能なダウンロード機能は、ファイルを複数のパートに分割し、各パートを個別にダウンロードしてから、それらを結合して完全なファイルにします。
注意事項
このトピックでは、中国 (杭州) リージョンのパブリックエンドポイントを使用します。OSS と同じリージョンにある他の Alibaba Cloud サービスから OSS にアクセスする場合は、内部エンドポイントを使用します。OSS のリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。
このトピックでは、OSS エンドポイントを使用して OSSClient インスタンスを作成します。カスタムドメイン名またはセキュリティトークンサービス (STS) を使用して OSSClient を作成する場合は、「OssClient インスタンスの作成」をご参照ください。
再開可能なダウンロードを実行するには、
oss:GetObject権限が必要です。詳細については、「RAM ユーザーへのカスタムポリシーのアタッチ」をご参照ください。
実装方法
`OssClient.ResumableDownloadObject` メソッドを使用して、再開可能なダウンロードを実行できます。このメソッドの `DownloadObjectRequest` には、次のパラメーターが含まれます。
パラメーター | 説明 | 必須 | デフォルト値 | 設定方法 |
bucket | バケット名。 | はい | なし | コンストラクターで設定します。 |
key | OSS オブジェクトの完全なパス。 | はい | なし | コンストラクターで設定します。 |
filePath | ローカルファイルの完全なパス。 | いいえ | OSS オブジェクト名 | コンストラクターで設定します。 |
partSize | シャードサイズ。値の範囲は 100 KB ~ 5 GB です。 | いいえ | 8 MB | `setPartSize` を使用して設定します。 |
threadNum | 同時シャードダウンロード数。 | いいえ | 3 | コンストラクターまたは `setThreadNum` を使用して設定します。 |
checkpointDir | ローカルシャードのダウンロード結果を記録するファイルです。このパラメーターを設定すると、再開可能なダウンロード機能が有効になります。ダウンロード中に進行状況情報がこのファイルに保存されます。シャードのダウンロードに失敗した場合、次のダウンロード試行はファイルに記録されたポイントから再開されます。ダウンロードが完了すると、このファイルは削除されます。 | いいえ | ダウンロードファイルと同じフォルダー。 | コンストラクターまたは `setCheckpointDir` を使用して設定します。 |
コードサンプル
次のコードは、再開可能なダウンロードを実行する方法を示しています。
#include <alibabacloud/oss/OssClient.h>
using namespace AlibabaCloud::OSS;
int main(void)
{
/* OSS アカウント情報を初期化します。*/
/* yourEndpoint を、バケットが配置されているリージョンのエンドポイントに設定します。たとえば、バケットが中国 (杭州) リージョンにある場合、エンドポイントを https://oss-cn-hangzhou.aliyuncs.com に設定します。*/
std::string Endpoint = "yourEndpoint";
/* yourRegion を、バケットが配置されているリージョンのリージョン ID に設定します。たとえば、バケットが中国 (杭州) リージョンにある場合、リージョン ID を cn-hangzhou に設定します。*/
std::string Region = "yourRegion";
/* バケット名を指定します (例: examplebucket)。*/
std::string BucketName = "examplebucket";
/* オブジェクトの完全なパスを指定します。完全なパスにバケット名を含めることはできません。例: exampledir/exampleobject.txt。*/
std::string ObjectName = "exampledir/exampleobject.txt";
/* オブジェクトを examplefile.txt という名前のローカルファイルにダウンロードし、指定したローカルパス (D:\\localpath) に保存します。ローカルファイルが存在する場合は上書きされ、存在しない場合は作成されます。*/
/* ローカルパスを指定しない場合、ダウンロードされたファイルはデフォルトでプロジェクトのローカルパスに保存されます。*/
std::string DownloadFilePath = "D:\\localpath\\examplefile.txt";
/* ブレークポイントレコードファイルのフォルダーを設定し、指定したフォルダーが存在することを確認します (例: D:\\localpath)。*/
/* オブジェクトのダウンロードが中断され、ブレークポイントレコードファイルが生成された場合は、対応するブレークポイントレコードファイルを設定してダウンロードを再開する必要があります。ダウンロードが完了すると、このファイルは削除されます。*/
std::string CheckpointFilePath = "D:\\localpath";
/* ネットワークリソースを初期化します。*/
InitializeSdk();
ClientConfiguration conf;
conf.signatureVersion = SignatureVersionType::V4;
/* 環境変数からアクセス認証情報を取得します。このコードサンプルを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。*/
auto credentialsProvider = std::make_shared<EnvironmentVariableCredentialsProvider>();
OssClient client(Endpoint, credentialsProvider, conf);
client.SetRegion(Region);
/* 再開可能なダウンロードを実行します。*/
DownloadObjectRequest request(BucketName, ObjectName, DownloadFilePath, CheckpointFilePath);
auto outcome = client.ResumableDownloadObject(request);
if (!outcome.isSuccess()) {
/* 例外を処理します。*/
std::cout << "ResumableDownloadObject fail" <<
",code:" << outcome.error().Code() <<
",message:" << outcome.error().Message() <<
",requestId:" << outcome.error().RequestId() << std::endl;
return -1;
}
/* ネットワークリソースを解放します。*/
ShutdownSdk();
return 0;
}関連ドキュメント
再開可能なダウンロードの完全なサンプルコードについては、「GitHub サンプル」をご参照ください。
再開可能なダウンロードの API 操作の詳細については、「GetObject」をご参照ください。