バケットから単一のオブジェクトをダウンロードする場合、最終変更時刻またはオブジェクトのETag (オブジェクトコンテンツの識別子) に基づいてダウンロード条件を指定できます。 指定されたダウンロード条件が満たされると、オブジェクトがダウンロードされます。 指定されたダウンロード条件が満たされない場合、エラーが返され、オブジェクトはダウンロードされません。 条件付きダウンロードを使用すると、ネットワーク伝送とリソース消費を削減し、ダウンロード効率を向上させることができます。
ダウンロード条件
利用可能なオブジェクトのダウンロード条件を次の表に示します。
"If-Modified-Since" と "If-Unmodified-Since" の両方が、オブジェクトのダウンロード条件と同時に存在することがあります。 "If-Match" と "If-None-Match" の両方が、オブジェクトのダウンロード条件と同時に存在することがあります。
ossClient.getObjectMetaを使用してETagを取得できます。
パラメーター | 説明 |
If-Modified-Since | 指定された時刻がオブジェクトが変更された時刻よりも早い場合、オブジェクトをダウンロードできます。 それ以外の場合、304 Not Modifiedが返されます。 |
If-Unmodified-Since | 指定された時刻が、オブジェクトが変更された時刻よりも後か等しい場合、オブジェクトをダウンロードできます。 そうでない場合、412 Precondition Failedが返されます。 |
If-Match | 指定された ETag がオブジェクトのものと一致すれば、そのオブジェクトをダウンロードすることができます。 そうでない場合、412 Precondition Failedが返されます。 |
If-None-Match | 指定された ETag がオブジェクトのものと一致しない場合は、オブジェクトをダウンロードできます。 それ以外の場合、304 Not Modifiedが返されます。 |
使用上の注意
このトピックでは、中国 (杭州) リージョンのパブリックエンドポイントを使用します。 OSSと同じリージョンにある他のAlibaba Cloudサービスを使用してObject Storage Service (OSS) にアクセスする場合は、内部エンドポイントを使用します。 OSSでサポートされているリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。
このトピックでは、アクセス資格情報は環境変数から取得します。 アクセス資格情報の設定方法の詳細については、「アクセス資格情報の設定」をご参照ください。
このトピックでは、OSSエンドポイントを使用してOSSClientインスタンスを作成します。 カスタムドメイン名またはSecurity Token Service (STS) を使用してOSSClientインスタンスを作成する場合は、「OSSClientインスタンスの作成」をご参照ください。
条件付きダウンロードを実行するには、
oss:GetObject
権限が必要です。 詳細については、「RAMユーザーへのカスタムポリシーのアタッチ」をご参照ください。
例
次のサンプルコードでは、ossClient.getObjectをダウンロード条件で使用してオブジェクトをダウンロードする方法の例を示します。 ossClient.downloadFileをダウンロード条件で使用して、ossClient.getObjectと同様の方法でオブジェクトをダウンロードできます。
com.aliyun.oss.ClientExceptionをインポートします。com.aliyun.oss.OSSをインポートします。impor t com.aliyun.oss.com mon.auth.*;
com.aliyun.oss.OSSClientBuilderをインポートします。com.aliyun.oss.OSSExceptionをインポートします。com.aliyun.oss.mo del.GetObjectRequestをインポートします。java.io. ファイルをインポートします。java.util.Dateをインポートします。public classデモ {
public static void main(String[] args) throws Exception {
// この例では、中国 (杭州) リージョンのエンドポイントが使用されます。 実際のエンドポイントを指定します。
String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 環境変数からアクセス資格情報を取得します。 サンプルコードを実行する前に、OSS_ACCESS_KEY_IDおよびOSS_ACCESS_KEY_SECRET環境変数が設定されていることを確認してください。
EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
// バケットの名前を指定します。 例: examplebucket.
String bucketName = "examplebucket";
// オブジェクトのフルパスを指定します。 バケット名をフルパスに含めないでください。 例: testfolder/exampleobject.txt。
文字列objectName = "testfolder/exampleobject.txt";
文字列pathName = "D :\\ localpath\\examplefile.txt";
// Create an OSSClient instance.
OSS ossClient = new OSSClientBuilder().build(endpoint, credentialsProvider);
try {
GetObjectRequest request = new GetObjectRequest(bucketName, objectName);
// たとえば、オブジェクトは2023年9月26日13:27:04に最後に変更されました。 指定された時刻が前回の変更時刻より前の場合 (9月25日火曜日13:27,04 CST 2023など) 、オブジェクトはIf-modified-Since条件を満たし、オブジェクトがダウンロードされます。
request.setModifiedSinceConstraint (新しい日付 (「9月25日火曜日13:27,04 CST 2023」));
// オブジェクトをローカルデバイスにダウンロードします。
ossClient.getObject(request, new File(pathName));
} catch (Exception e) {
System.out.println("Caught an OSSException, which means your request made it to OSS, "
+ "しかし、何らかの理由でエラー応答で拒否されました。");
System.out.println("エラーメッセージ:" + oe.getErrorMessage());
System.out.println("エラーコード:" + oe.getErrorCode());
System.out.println("リクエストID:" + oe.getRequestId());
System.out.println("ホストID:" + oe.getHostId());
} catch (ClientException e) {
System.out.println("Caught an ClientException, which means the client encountered "
+ "a serious internal problem while trying to communicate with OSS, "
+ 「ネットワークにアクセスできないなど」;
System.out.println("エラーメッセージ:" + ce.getMessage());
} 最後に{
if (ossClient != null) {
ossClient.shutdown();
}
}
}
}
参考資料
条件付きダウンロードを実行するために呼び出すことができるAPI操作の詳細については、「GetObject」をご参照ください。