CloudBox での OSS の使い方 - Object Storage Service - Alibaba Cloud ドキュメントセンター

クラウドボックスの OSS を使用すると、ローカルデータをモニターおよび処理できます。低遅延が求められるユースケースや、複数の支社を統一的に管理するユースケースに最適です。このトピックでは、クラウドボックスの OSS の基本操作（バケットの作成、オブジェクトのアップロード、オブジェクトのダウンロード）について説明します。

前提条件

クラウドボックスの OSS は、中国 (杭州)、中国 (上海)、中国 (深セン)、中国 (河源)、中国 (北京)、および中国 (成都) リージョンでのみ利用可能です。
CloudBox を購入しました。
CloudBox 用にVPC と vSwitch を作成しました。
CloudBox の VPC に対して SingleTunnel ネットワークタイプをリクエストするために、テクニカルサポートに連絡済みである必要があります。

ステップ 1：バケットの作成

OSS コンソールを使用する

OSS コンソールにログインします。
左側のナビゲーションウィンドウで、データサービス > CloudBox Bucket を選択し、左上隅の バケットの作成 をクリックします。
バケットの作成 ページで、バケット名を入力し、デフォルト設定のままにしてから、OK をクリックします。

バケット名は以下の要件を満たす必要があります。
- バケット名は CloudBox 内で一意である必要があります。
- 名前には小文字、数字、ハイフン (-) のみを使用できます。
- 名前の先頭および末尾は小文字または数字である必要があります。
- 名前の長さは 3～63 文字である必要があります。

Java SDK を使用する

SDK を使用してクラウドボックスの OSS バケットを作成するには、Alibaba Cloud SDK for Java バージョン 3.15.0 以降を使用する必要があります。

import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import com.aliyun.oss.model.CreateBucketRequest;
import com.aliyun.oss.common.auth.DefaultCredentialProvider;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.ClientBuilderConfiguration;
import com.aliyun.oss.common.auth.CredentialsProviderFactory;
import com.aliyun.oss.common.auth.EnvironmentVariableCredentialsProvider;

public class Demo {

    public static void main(String[] args) throws Exception {
        // クラウドボックスの OSS バケットのデータエンドポイントを指定します。
        String endpoint = "https://cb-f8z7yvzgwfkl9q0h****.cn-hangzhou.oss-cloudbox.aliyuncs.com";
        // 環境変数からアクセス認証情報を取得します。このサンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // クラウドボックスの OSS バケットの名前を指定します（例：examplebucket）。
        String bucketName = "examplebucket";
        // クラウドボックスの OSS バケットが配置されているリージョンを指定します。
        String region = "cn-hangzhou";
        // Cloud Box ID を指定します。
        String cloudBoxId = "cb-f8z7yvzgwfkl9q0h****";


        // OSSClient インスタンスを作成します。
        // クライアントが不要になったら shutdown() を呼び出してリソースを解放します。
        ClientBuilderConfiguration conf = new ClientBuilderConfiguration();
        conf.setSignatureVersion(SignVersion.V4);
        OSS ossClient = OSSClientBuilder.create()
                .endpoint(endpoint)
                .credentialsProvider(new DefaultCredentialProvider(credentialsProvider.getCredentials()))
                .clientConfiguration(conf)
                .region(region)
                .cloudBoxId(cloudBoxId)
                .build();

        try {
            // CreateBucketRequest オブジェクトを作成します。
            CreateBucketRequest createBucketRequest = new CreateBucketRequest(bucketName);            
                       
            // クラウドボックスの OSS バケットの ACL を public-read に設定します。デフォルトの ACL は private です。
            //createBucketRequest.setCannedACL(CannedAccessControlList.PublicRead);

            // クラウドボックスの OSS バケットを作成します。
            ossClient.createBucket(createBucketRequest);
        } catch (OSSException oe) {
            System.out.println("Caught an OSSException, which means your request reached OSS but was rejected with an error response.");
            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 (ClientException ce) {
            System.out.println("Caught a ClientException, which means the client encountered "
                    + "a serious internal problem while trying to communicate with OSS, "
                    + "such as not being able to access the network.");
            System.out.println("Error Message:" + ce.getMessage());
        } finally {
            if (ossClient != null) {
                ossClient.shutdown();
            }
        }
    }
}

ossutil を使用する

ossutil を使用してクラウドボックスの OSS バケットを作成する方法については、「put-bucket」をご参照ください。

REST API を使用する

アプリケーションで高度なカスタマイズが必要な場合は、REST API を直接呼び出すことができます。この場合、署名を手動で計算するコードを記述する必要があります。詳細については、「PutBucket」をご参照ください。

ステップ 2：オブジェクトのアップロード

Java SDK を使用する

Alibaba Cloud OSS SDK for Java バージョン 3.15.0 以降を使用して、ローカルファイルをクラウドボックスの OSS バケットにアップロードできます。

import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import com.aliyun.oss.model.PutObjectRequest;
import java.io.File;
import com.aliyun.oss.common.auth.DefaultCredentialProvider;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.ClientBuilderConfiguration;
import com.aliyun.oss.common.auth.CredentialsProviderFactory;
import com.aliyun.oss.common.auth.EnvironmentVariableCredentialsProvider;

public class Demo {

    public static void main(String[] args) throws Exception {
        // クラウドボックスの OSS バケットのデータエンドポイントを指定します。
        String endpoint = "https://cb-f8z7yvzgwfkl9q0h****.cn-hangzhou.oss-cloudbox.aliyuncs.com";
        // 環境変数からアクセス認証情報を取得します。このサンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // クラウドボックスの OSS バケットの名前を指定します（例：examplebucket）。
        String bucketName = "examplebucket";
        // クラウドボックスの OSS バケットが配置されているリージョンを指定します。
        String region = "cn-hangzhou";
        // CloudBox の ID を指定します。
        String cloudBoxId = "cb-f8z7yvzgwfkl9q0h****";
        // オブジェクトの完全なパスを指定します。完全なパスにはバケット名を含めないでください（例：exampledir/exampleobject.txt）。
        String objectName = "exampledir/exampleobject.txt";
        // ローカルファイルの完全なパスを指定します（例：D:\\localpath\\examplefile.txt）。
        // ローカルパスを指定しない場合、ファイルはサンプルプログラムが属するプロジェクトのローカルパスからアップロードされます。
        String filePath= "D:\\localpath\\examplefile.txt";

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

        try {
            // PutObjectRequest オブジェクトを作成します。
            PutObjectRequest putObjectRequest = new PutObjectRequest(bucketName, objectName, new File(filePath));
            // アップロード中にストレージクラスおよびアクセス権限を設定するには、次のサンプルコードを参照してください。
            // ObjectMetadata metadata = new ObjectMetadata();
            // metadata.setHeader(OSSHeaders.OSS_STORAGE_CLASS, StorageClass.Standard.toString());
            // metadata.setObjectAcl(CannedAccessControlList.Private);
            // putObjectRequest.setMetadata(metadata);

            // ファイルをアップロードします。
            ossClient.putObject(putObjectRequest);
        } catch (OSSException oe) {
            System.out.println("Caught an OSSException, which means your request made it to OSS, "
                    + "but was rejected with an error response for some reason.");
            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 (ClientException ce) {
            System.out.println("Caught an ClientException, which means the client encountered "
                    + "a serious internal problem while trying to communicate with OSS, "
                    + "such as not being able to access the network.");
            System.out.println("Error Message:" + ce.getMessage());
        } finally {
            if (ossClient != null) {
                ossClient.shutdown();
            }
        }
    }
}

ossutil を使用する

ossutil を使用したシンプルなアップロードについては、「cp (upload files)」をご参照ください。

REST API を使用する

アプリケーションで高度なカスタマイズが必要な場合は、REST API を直接呼び出すことができます。この場合、署名を手動で計算するコードを記述する必要があります。詳細については、「PutObject」をご参照ください。

ステップ 3：オブジェクトのダウンロード

Java SDK を使用する

Java SDK バージョン 3.15.0 以降を使用してオブジェクトをダウンロードできます。

package com.aliyun.oss.demo;

import com.aliyun.oss.ClientException;
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.model.GetObjectRequest;
import java.io.File;
import com.aliyun.oss.common.auth.DefaultCredentialProvider;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.ClientBuilderConfiguration;
import com.aliyun.oss.common.auth.CredentialsProviderFactory;
import com.aliyun.oss.common.auth.EnvironmentVariableCredentialsProvider;

public class Demo {

    public static void main(String[] args) throws Exception {
        // クラウドボックスの OSS バケットのデータエンドポイントを指定します。
        String endpoint = "https://cb-f8z7yvzgwfkl9q0h****.cn-hangzhou.oss-cloudbox.aliyuncs.com";
        // 環境変数からアクセス認証情報を取得します。このサンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // クラウドボックスの OSS バケットの名前を指定します（例：examplebucket）。
        String bucketName = "examplebucket";
        // クラウドボックスの OSS バケットが配置されているリージョンを指定します。
        String region = "cn-hangzhou";
        // CloudBox の ID を指定します。
        String cloudBoxId = "cb-f8z7yvzgwfkl9q0h****";
        // オブジェクトの完全なパスを指定します。完全なパスにはバケット名を含めないでください（例：exampledir/exampleobject.txt）。
        String objectName = "exampledir/exampleobject.txt";
        // ローカルファイルの完全なパスを指定します。
        String pathName = "D:\\localpath\\examplefile.txt";

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

        try {
            // オブジェクトをローカルファイルにダウンロードし、指定されたローカルパスに保存します。指定されたローカルファイルが存在する場合は上書きされ、存在しない場合は新規作成されます。
            // ローカルパスを指定しない場合、ダウンロードされたファイルはサンプルプログラムが属するプロジェクトのローカルパスに保存されます。
            ossClient.getObject(new GetObjectRequest(bucketName, objectName), new File(pathName));
        } catch (OSSException oe) {
            System.out.println("Caught an OSSException, which means your request made it to OSS, "
                    + "but was rejected with an error response for some reason.");
            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 (ClientException ce) {
            System.out.println("Caught an ClientException, which means the client encountered "
                    + "a serious internal problem while trying to communicate with OSS, "
                    + "such as not being able to access the network.");
            System.out.println("Error Message:" + ce.getMessage());
        } finally {
            if (ossClient != null) {
                ossClient.shutdown();
            }
        }
    }
}

ossutil を使用する

ossutil を使用したシンプルなダウンロードについては、「cp (download files)」をご参照ください。

REST API を使用する

アプリケーションで高度なカスタマイズが必要な場合は、REST API を直接呼び出すことができます。この場合、署名を手動で計算するコードを記述する必要があります。詳細については、「GetObject」をご参照ください。