Object Storage Service:再開可能なアップロード (Java SDK V1)

注意事項

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

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

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

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

サンプルコード

次のコードは、再開可能なアップロードを実行する方法の例を示しています。

import com.aliyun.oss.ClientBuilderConfiguration;
import com.aliyun.oss.OSS;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.*;

public class UploadFile {
        public static void main(String[] args) throws Exception {
            // この例では、中国 (杭州) リージョンのエンドポイントを使用します。実際のエンドポイントを指定してください。
            String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
            // バケットが配置されているリージョンを指定します。たとえば、バケットが中国 (杭州) リージョンにある場合は、リージョンを cn-hangzhou に設定します。
            String region = "cn-hangzhou";
            // 環境変数からアクセス認証情報を取得します。このコードを実行する前に、環境変数 OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET が設定されていることを確認してください。
            EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();

            // OSSClient インスタンスを作成します。
            // OSSClient インスタンスが不要になったら、shutdown メソッドを呼び出してリソースを解放します。
            ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
            clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);
            OSS ossClient = OSSClientBuilder.create()
                    .endpoint(endpoint)
                    .credentialsProvider(credentialsProvider)
                    .clientConfiguration(clientBuilderConfiguration)
                    .region(region)
                    .build();

            try {
                ObjectMetadata meta = new ObjectMetadata();
                // アップロードするオブジェクトのコンテンツタイプを指定します。
                // meta.setContentType("text/plain");

                // アップロード中にオブジェクトのアクセス制御リスト (ACL) を設定します。
                // meta.setObjectAcl(CannedAccessControlList.Private);

                // UploadFileRequest を使用して複数のパラメーターを設定します。
                // バケット名 (examplebucket など) とオブジェクトの完全なパス (exampledir/exampleobject.txt など) を指定します。完全なパスにバケット名を含めることはできません。
                UploadFileRequest uploadFileRequest = new UploadFileRequest("examplebucket","exampledir/exampleobject.txt");

                // UploadFileRequest を使用して単一のパラメーターを設定します。
                // ローカルファイルの完全なパス (例: D:\\localpath\\examplefile.txt) を指定します。ローカルパスを指定しない場合、ファイルはサンプルプログラムが配置されているプロジェクトのパスからアップロードされます。
                uploadFileRequest.setUploadFile("D:\\localpath\\examplefile.txt");
                // アップロード用の同時スレッド数を指定します。デフォルト値は 1 です。
                uploadFileRequest.setTaskNum(5);
                // パートサイズをバイト単位で指定します。値の範囲は 100 KB から 5 GB までです。デフォルト値は 100 KB です。
                uploadFileRequest.setPartSize(1 * 1024 * 1024);
                // 再開可能なアップロードを有効にします。この機能はデフォルトで無効になっています。
                uploadFileRequest.setEnableCheckpoint(true);
                // マルチパートアップロードの進行状況を記録するファイルです。アップロードの進行状況がこのファイルに保存されます。パートのアップロードに失敗した場合、再試行すると記録されたブレークポイントからアップロードが再開されます。アップロードが完了すると、このファイルは削除されます。
                // このパラメーターを設定しない場合、チェックポイントファイルはアップロードするローカルファイルと同じディレクトリに保存され、名前は ${uploadFile}.ucp になります。
                uploadFileRequest.setCheckpointFile("yourCheckpointFile");
                // ファイルのメタデータ。
                uploadFileRequest.setObjectMetadata(meta);
                // アップロードコールバックを設定します。パラメーターは Callback 型です。
                //uploadFileRequest.setCallback("yourCallbackEvent");

                // 再開可能なアップロードを実行します。
                ossClient.uploadFile(uploadFileRequest);

            } catch (OSSException oe) {
                System.out.println("OSSException がキャッチされました。これは、リクエストが OSS に到達しましたが、何らかの理由でエラー応答で拒否されたことを意味します。");
                System.out.println("Error Message:" + oe.getErrorMessage());
                System.out.println("Error Code:" + oe.getErrorCode());
                System.out.println("Request ID:" + oe.getRequestId());
                System.out.println("Host ID:" + oe.getHostId());
            } catch (Throwable ce) {
                System.out.println("ClientException がキャッチされました。これは、クライアントが OSS との通信を試みている間に、ネットワークにアクセスできないなど、深刻な内部問題が発生したことを意味します。");
                System.out.println("Error Message:" + ce.getMessage());
            } finally {
                // OSSClient インスタンスをシャットダウンします。
                if (ossClient != null) {
                    ossClient.shutdown();
                }
            }
        }
}

関連ドキュメント

再開可能なアップロードの完全なサンプルコードについては、「GitHub の例」をご参照ください。