OSSClient は、バケットやオブジェクトなどの OSS リソースを管理するための OSS C# クライアントとして機能します。

OSSClient インスタンスの作成

OSSClient インスタンスを作成するには、エンドポイントを指定する必要があります。 エンドポイントの詳細については、「リージョンおよびエンドポイント」および「カスタムドメイン名のバインド方法」をご参照ください。

  • OSS ドメインを使用して OSSClient インスタンスを作成

    次のコードを実行して、OSS によって割り当てられたドメインを使用して OSSClient インスタンスを作成します。

    using Aliyun.OSS;
    
    const string accessKeyId = "<yourAccessKeyId>";
    const string accessKeySecret = "<yourAccessKeySecret>";
    const string endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
    
    // Create a new OSSClient instance with the OSS access address specified by the user and the AccessKeyId/AccessKeySecret granted by Alibaba Cloud.
    var ossClient = new OssClient(endpoint, accessKeyId, accessKeySecret);
    
    
  • カスタムドメイン (CNAME) を使用して OSSClient インスタンスを作成

    次のコードを実行して、CNAME で OSSClient インスタンスを作成します。

    using Aliyun.OSS;
    using Aliyun.OSS.Common;
    
    const string accessKeyId = "<yourAccessKeyId>";
    const string accessKeySecret = "<yourAccessKeySecret>";
    const string endpoint = "<yourDomain>";
    
    // Create a ClientConfiguration instance. Modify parameters as required.
    var conf = new ClientConfiguration();
    
    // Enable CNAME. CNAME indicates a custom domain bound to a bucket.
    conf.IsCname = true;
    
    // Create an OSSClient instance.
    var client = new OssClient(endpoint, accessKeyId, accessKeySecret, conf);
    
    CNAME が使用されている場合、ossClient.listBuckets メソッドは使用できません。

OSSClient インスタンスの設定

ClientConfiguration は OSSClient の設定クラスです。 ClientConfiguration は、ユーザーエージェント、ホストプロキシ、接続タイムアウト、最大接続数などのパラメーターを設定するために使用されます。 以下のパラメーターを設定します。

パラメーター 説明 設定方法
ConnectionLimit 有効にできる HTTP 接続の最大数を指定します。 512
MaxErrorRetry 要求エラーが発生した場合の最大再試行回数を指定します。 3
ConnectionTimeout 接続が確立されるときのタイムアウト時間をミリ秒単位で指定します。 既定値は -1 です。これは、接続がタイムアウトしていないことを表します。 -1
IsCname CNAME をエンドポイントとして使用できるかどうかを指定します。 false
ProgressUpdateInterval プログレスバーの更新間隔をバイト単位で指定します。 8096

コード例は次のとおりです。

using Aliyun.OSS;
using Aliyun.OSS.Common;

var conf = new ClientConfiguration();
conf.ConnectionLimit = 512;
conf.MaxErrorRetry = 3;
conf.ConnectionTimeout = 300;

var client = new OssClient(endpoint, accessKeyId, accessKeySecret, conf);
  • データ検証

    MD5 データ検証には、次のコードを実行します。

    using Aliyun.OSS;
    using Aliyun.OSS.Common;
    
    var conf = new ClientConfiguration();
    // Enable MD5 verification. Set EnableMD5Check to perform MD5 verification on the uploaded or downloaded data. この機能はデフォルトで無効です。
    conf.EnalbeMD5Check = true;
    
    var client = new OssClient(endpoint, accessKeyId, accessKeySecret, conf);
    
    MD5 検証を無効にすると、システムパフォーマンスが低下します。
  • Proxy network

    プロキシネットワークを使用している場合は、OSS にアクセスするために次のパラメータを設定します。

    パラメーター 説明 既定値
    ProxyHost 8.8.8.8abc.def.com などのプロキシサーバー。 Null
    ProxyPort 31288080 などのプロキシポート。 Null
    ProxyUserName プロキシサービスアカウント。オプションです。 Null
    ProxyPassword プロキシサービスのパスワード。オプションです。 Null

    アカウントとパスワードを使用せずに、プロキシネットワークにアクセスする例は次のとおりです。

    using Aliyun.OSS;
    using Aliyun.OSS.Common;
    
    var conf = new ClientConfiguration();
    conf.ProxyHost = "8.8.8.8";
    conf.ProxyPort = 3128;
    
    var client = new OssClient(endpoint, accessKeyId, accessKeySecret, conf);
    

    アカウントとパスワードを使用した、プロキシネットワークアクセスの例は次のとおりです。

    using Aliyun.OSS;
    using Aliyun.OSS.Common;
    
    var conf = new ClientConfiguration();
    conf.ProxyHost = "8.8.8.8";
    conf.ProxyPort = 3128;
    conf.ProxyUserName = "user";
    conf.ProxyPassword = "6666";
    
    var client = new OssClient(endpoint, accessKeyId, accessKeySecret, conf);