CloudBox にデプロイされた OSS をすぐに使い始める方法 - Object Storage Service

CloudBox の Object Storage Service (OSS) を使用すると、ローカルデータを監視および処理できます。 CloudBox の OSS は、低レイテンシと複数ブランチの統合管理が必要なシナリオに適しています。このトピックでは、CloudBox の OSS バケットの作成、CloudBox の OSS バケットへのオブジェクトのアップロードとダウンロードなど、CloudBox の OSS の基本操作について説明します。

前提条件

CloudBox の OSS は、中国 (杭州)、中国 (上海)、中国 (深圳)、中国 (河源)、中国 (北京)、中国 (成都) リージョンでのみサポートされています。
クラウドボックスが購入済みであること。詳細については、「クラウドボックスを購入する」をご参照ください。
CloudBox の OSS に Virtual Private Cloud (VPC) と vSwitch が作成されていること。詳細については、「VPC と vSwitch を作成する」をご参照ください。
VPC 内部ネットワークがセットアップされ、単一トンネルが構成されて安全な接続が提供されていること。この機能を申請するには、テクニカルサポートにお問い合わせください。

手順 1：CloudBox の OSS バケットを作成する

OSS コンソールを使用する

OSS コンソールにログインします。
左側のナビゲーションウィンドウで、データサービス > [CloudBox の OSS バケット] を選択します。
[CloudBox の OSS バケット] ページで、左上隅にある [バケットの作成] をクリックします。
[バケットの作成] パネルで、CloudBox の OSS バケットの名前を指定し、その他のパラメーターについてはデフォルト設定を保持して、[OK] をクリックします。
CloudBox の OSS バケットの名前は、次の要件を満たしている必要があります。
- 指定した CloudBox の OSS バケットの名前は、クラウドボックス内の既存の CloudBox の OSS バケットの名前と同じにすることはできません。
- 名前に使用できるのは、小文字、数字、およびハイフン (-) のみです。
- 名前は小文字または数字で始まり、小文字または数字で終わる必要があります。
- 名前は 3 ～ 63 文字の長さである必要があります。

OSS SDK for Java を使用する

CloudBox の OSS バケットは、OSS SDK for Java を使用することによってのみ作成できます。 OSS 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 {
        // CloudBox の OSS バケットのデータエンドポイントを指定します。
        String endpoint = "https://cb-f8z7yvzgwfkl9q0h****.cn-hangzhou.oss-cloudbox.aliyuncs.com";
        // 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が構成されていることを確認してください。
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // CloudBox の OSS バケットの名前を指定します。例：examplebucket。
        String bucketName = "examplebucket";
        // CloudBox の OSS バケットが配置されているリージョンを指定します。
        String region = "cn-hangzhou";
        // クラウドボックスの ID を指定します。
        String cloudBoxId = "cb-f8z7yvzgwfkl9q0h****";


        // OSSClient インスタンスを作成します。
        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);            
                       
            // CloudBox の OSS バケットの ACL を public-read に設定します。デフォルトの ACL は private です。
            //createBucketRequest.setCannedACL(CannedAccessControlList.PublicRead);

            // CloudBox の OSS バケットを作成します。
            ossClient.createBucket(createBucketRequest);
        } 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 を使用して、CloudBox の OSS バケットを作成できます。詳細については、「put-bucket」をご参照ください。

OSS API を使用する

ビジネスで高度なカスタマイズが必要な場合は、RESTful API を直接呼び出すことができます。 RESTful API を直接呼び出すには、コードに署名計算を含める必要があります。詳細については、「PutBucket」をご参照ください。

手順 2：オブジェクトをアップロードする

OSS SDK for Java を使用する

OSS SDK for Java のみを使用して、ローカルファイルを CloudBox の OSS バケットにアップロードできます。 OSS SDK for Java のバージョンは 3.15.0 以降である必要があります。次のサンプルコードは、OSS SDK for Java を使用してローカルファイルを CloudBox の 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 {
        // CloudBox の OSS バケットのデータエンドポイントを指定します。
        String endpoint = "https://cb-f8z7yvzgwfkl9q0h****.cn-hangzhou.oss-cloudbox.aliyuncs.com";
        // 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が構成されていることを確認してください。
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // CloudBox の OSS バケットの名前を指定します。例：examplebucket。
        String bucketName = "examplebucket";
        // CloudBox の OSS バケットが配置されているリージョンを指定します。
        String region = "cn-hangzhou";
        // クラウドボックスの ID を指定します。
        String cloudBoxId = "cb-f8z7yvzgwfkl9q0h****";
        // オブジェクトの完全なパスを指定します。完全なパスにバケット名を含めないでください。例：exampledir/exampleobject.txt。
        String objectName = "exampledir/exampleobject.txt";
        // アップロードするローカルファイルの完全なパスを指定します。例：D:\\localpath\\examplefile.txt。
        // ローカルファイルのパスが指定されていない場合、ローカルファイルは、サンプルプログラムが属するプロジェクトのパスからアップロードされます。
        String filePath= "D:\\localpath\\examplefile.txt";

        // OSSClient インスタンスを作成します。
        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));
            // 次のサンプルコードは、オブジェクトをアップロードするときに、オブジェクトのストレージクラスとアクセス制御リスト (ACL) を指定する方法の例を示しています。
            // 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 を使用して、シンプルアップロードで CloudBox の OSS バケットにオブジェクトをアップロードできます。詳細については、「cp (オブジェクトのアップロード)」をご参照ください。

OSS API を使用する

ビジネスで高度なカスタマイズが必要な場合は、RESTful API を直接呼び出すことができます。 API を直接呼び出すには、コードに署名計算を含める必要があります。詳細については、「PutObject」をご参照ください。

手順 3：オブジェクトをダウンロードする

OSS SDK for Java を使用する

OSS SDK for Java のみを使用して、CloudBox の OSS バケットからオブジェクトをダウンロードできます。 OSS SDK for Java のバージョンは 3.15.0 以降である必要があります。次のサンプルコードは、OSS SDK for Java を使用してオブジェクトをダウンロードする方法の例を示しています。

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

        // OSSClient インスタンスを作成します。
        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 を使用して、シンプルアップロードで CloudBox の OSS バケットにオブジェクトをアップロードできます。詳細については、「cp (ファイルのダウンロード)」をご参照ください。

OSS API を使用する

ビジネスで高度なカスタマイズが必要な場合は、RESTful API を直接呼び出すことができます。 API を直接呼び出すには、コードに署名計算を含める必要があります。詳細については、「GetObject」をご参照ください。