すべてのプロダクト
Search
ドキュメントセンター

Object Storage Service:部分ダウンロード

最終更新日:Dec 15, 2023

範囲ダウンロードを使用して、特定の範囲のオブジェクトデータをダウンロードできます。

使用上の注意

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

  • このトピックでは、アクセス資格情報は環境変数から取得します。 アクセス資格情報の設定方法の詳細については、「アクセス資格情報の設定」をご参照ください。

  • このトピックでは、OSSエンドポイントを使用してOSSClientインスタンスを作成します。 カスタムドメイン名またはSecurity Token Service (STS) を使用してOSSClientインスタンスを作成する場合は、「OSSClientインスタンスの作成」をご参照ください。

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

データをダウンロードする有効な範囲を指定する

次のサンプルコードは、データをダウンロードするための有効な範囲を指定する方法の例を示しています。

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をインポートします。com.aliyun.oss.mo del.OSSObjectをインポートします。java.io.InputStreamをインポートします。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";
        // オブジェクトのフルパスを指定します。 例: exampledir/exampleobject.txt。 バケット名をフルパスに含めないでください。 
        文字列objectName = "exampledir/exampleobject.txt";

        // Create an OSSClient instance. 
        OSS ossClient = new OSSClientBuilder().build(endpoint, credentialsProvider);
        InputStream in = null;
        try {
            GetObjectRequest getObjectRequest = new GetObjectRequest(bucketName, objectName);
            // サイズが1,000バイトのオブジェクトの場合、有効な範囲はバイト0からバイト999です。 
            // 合計1,000バイトを含む、バイト0からバイト999の範囲内のデータを照会します。 指定された範囲が無効な場合、オブジェクト全体がダウンロードされます。 たとえば、指定された範囲が負の数を含む場合、または指定された値がオブジェクトサイズよりも大きい場合、オブジェクトのすべてのコンテンツがダウンロードされます。 
            getObjectRequest.setRange(0、999);

            // Start range download. 
            OSSObject ossObject = ossClient.getObject(getObjectRequest);

            // データを読み取ります。 
            byte[] buf = new byte[1024];
            in = ossObject.getObjectContent();
            for (int n = 0; n != -1; ) {
                n = in.read(buf, 0, buf.length);
            }
            ossObject.close();
        } 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();
            }
            // データの読み取り後、取得したストリームを閉じる必要があります。 そうしないと、接続リークが発生する可能性があります。 Consequently, no connections are available and an exception occurs. 
            if (in != null) {
                in.close();
            }
        }
    }
}            

ストリーミングダウンロードは、一度にすべてのデータを読み取ることはできません。 ストリーミングモードでOSSから64 KBのデータを読み取るには、次の方法を使用して、64 KBのデータまたはオブジェクト全体が読み取られるまで、データを複数回読み取ることができます。 詳細については、「InputStream.read」をご参照ください。

byte[] buf = new byte[1024];
=ossObject.getObjectContent() 内のInputStream;
for (int n = 0; n != -1; ) {
    n = in.read(buf, 0, buf.length);
}
in.close(); 

データをダウンロードする無効な範囲を指定する

サイズが1,000バイトのオブジェクトの場合、有効な範囲はバイト0からバイト999までです。 指定された範囲がバイト0からバイト999の範囲内にない場合、範囲は有効になりません。 この場合、OSSはHTTPステータスコード200とオブジェクト全体のデータを返します。 次の例は、無効なリクエストと返された結果を示しています。

  • Range: bytesを500-2000に設定した場合、範囲の末尾の値は無効です。 この場合、OSSはHTTPステータスコード200とオブジェクト全体のデータを返します。

  • Range: bytesを1000-2000に設定した場合、範囲の先頭の値は無効です。 この場合、OSSはHTTPステータスコード200とオブジェクト全体のデータを返します。

範囲別にデータをダウンロードする標準動作を指定する

リクエストヘッダーにx-oss-range-behavior:standardを追加すると、指定された範囲が有効な範囲内にない場合、ダウンロードの動作が変更されます。 サイズが1,000バイトのオブジェクトの場合:

  • Range: bytesを500-2000に設定した場合、範囲の末尾の値は無効です。 この場合、OSSはHTTPステータスコード206と、バイト500からバイト999の範囲内のデータを返します。

  • Range: bytesを1000-2000に設定した場合、範囲の先頭の値は無効です。 この場合、OSSはHTTPステータスコード416とInvalidRangeエラーコードを返します。

次のサンプルコードでは、範囲ごとにデータをダウンロードする標準の動作を指定する方法の例を示します。

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をインポートします。com.aliyun.oss.mo del.OSSObjectをインポートします。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";
        // オブジェクトのフルパスを指定します。 例: exampledir/exampleobject.txt。 バケット名をフルパスに含めないでください。 
        文字列objectName = "exampledir/exampleobject.txt";

        // Create an OSSClient instance. 
        OSS ossClient = new OSSClientBuilder().build(endpoint, credentialsProvider);

        try {
            // 範囲の末尾の値が無効な場合、OSSはHTTPステータスコード206と、バイト500からバイト999の範囲内のデータを返します。 
            GetObjectRequest getObjectRequest = new GetObjectRequest(bucketName, objectName);
            getObjectRequest.setRange(500、2000);
            getObjectRequest.addHeader("x-oss-range-behavior" 、"standard");
            OSSObject ossObject = ossClient.getObject(getObjectRequest);
            ossObject.close();

            System.out.println("standard get" + "500 ~ 2000" + "statusCode:" + ossObject.getResponse().getStatusCode());
            System.out.println("standard get" + "500 ~ 2000" + "contentLength:" + ossObject.getResponse().getContentLength());

            // 範囲の先頭の値が無効な場合、次のコードで例外が返されます。 OSSは、HTTPステータスコード416とInvalidRangeエラーコードを返します。 
            getObjectRequest = new GetObjectRequest(bucketName, objectName);
            getObjectRequest.setRange(1000、2000);
            getObjectRequest.addHeader("x-oss-range-behavior" 、"standard");
            OSSObject ossObject2 = ossClient.getObject(getObjectRequest);
            ossObject2.close();
        } 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」をご参照ください。