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

Tablestore:OTSClient インスタンスの初期化

最終更新日:Dec 28, 2024

OTSClient は Tablestore のクライアントです。OTSClient は、テーブルの管理、単一行または複数行に対する読み取りおよび書き込み操作の実行に使用できるさまざまなメソッドを提供します。.NET SDK for Tablestore を使用してリクエストを開始するには、OTSClient インスタンスを初期化し、ビジネス要件に基づいて OTSClientConfig のデフォルト設定を変更する必要があります。

使用上の注意

Tablestore .NET SDK はマルチスレッドをサポートしています。タスクの複数スレッドを実行するには、同じ OTSClient オブジェクトを使用することをお勧めします。

準備

OTSClient インスタンスを初期化する前に、Tablestore インスタンスのエンドポイントを取得し、Tablestore .NET SDK をインストールしてから、アクセス認証情報を設定する必要があります。

Tablestore インスタンスのエンドポイントの取得

Tablestore インスタンスを作成した後、インスタンスのエンドポイントを取得する必要があります。その後、エンドポイントを使用してインスタンスにアクセスできます。

エンドポイントは、リージョン内の Tablestore インスタンスにアクセスするために使用されるドメイン名です。たとえば、https://sun.cn-hangzhou.ots.aliyuncs.com は、中国 (杭州) リージョンにある sun という名前のインスタンスに HTTPS 経由でアクセスするために使用されるパブリックエンドポイントです。詳細については、「エンドポイント」を参照してください。

  1. Tablestore サービスがアクティブ化されていない場合は、アクティブ化します。詳細については、「Tablestore のアクティブ化」を参照してください。

  2. Tablestore インスタンスを作成します。詳細については、「インスタンスの作成」を参照してください。

  3. 作成したインスタンスのエンドポイントを取得します。

    1. Tablestore コンソール にログインします。

    2. 概要ページで、作成したインスタンスを見つけ、インスタンス名をクリックします。

    3. インスタンスアクセス URL セクションの インスタンスの詳細 タブで、インスタンスのエンドポイントを表示します。

      image

.NET SDK for Tablestore のインストールTablestore.NET SDK

詳細については、「.NET SDK for Tablestore のインストール」を参照してください。

アクセス認証情報の設定

Tablestore にアクセスするには、身元を確認するための有効な AccessKey ペアが必要です。詳細については、「アクセス認証情報の設定」を参照してください。

OTSClient インスタンスの初期化

.NET SDK for Tablestore を使用するには、最初に OTSClient インスタンスを作成する必要があります。その後、OTSClient インスタンスの操作を呼び出して Tablestore にアクセスできます。

API 操作

/// <summary>
/// OTSClient インスタンスを作成するために使用される関数。
/// </summary>
/// <param name="endPoint">Tablestore インスタンスのエンドポイント。https:// で始まる必要があります。例: https://instance.cn-hangzhou.ots.aliyun.com:80 </param>
/// <param name="accessKeyID"> Tablestore インスタンスへのアクセスに使用される AccessKey ID。Alibaba Cloud 公式 Web サイトで AccessKey ID を取得できます。 </param>
/// <param name="accessKeySecret"> Tablestore インスタンスへのアクセスに使用される AccessKey シークレット。Alibaba Cloud 公式 Web サイトで AccessKey シークレットを取得できます。 </param>
/// <param name="instanceName"> Tablestore インスタンスの名前。Tablestore コンソールでインスタンス名を取得できます。 </param>
public OTSClient(string endPoint, string accessKeyID, string accessKeySecret, string instanceName);

/// <summary>
/// クライアントで OTSClientConfig クラスのインスタンスを設定することにより、OTSClient インスタンスを作成します。
/// </summary>
/// <param name="config">インスタンスのクライアント設定。</param>
public OTSClient(OTSClientConfig config);                   

警告

Alibaba Cloud アカウントの AccessKey ペアは、すべての API 操作に対する権限を持っています。API 操作の呼び出しや日常的な O&M の実行には、RAM ユーザーを使用することをお勧めします。AccessKey ID と AccessKey シークレットをプロジェクトコードにハードコードしないことをお勧めします。そうしないと、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが侵害される可能性があります。この例では、セキュリティトークンと AccessKey ペアは環境変数に保存されています。

説明

サンプルコードを実行する前に、OTS_AK_ENV および OTS_SK_ENV 環境変数が設定されていることを確認してください。詳細については、「アクセス認証情報の設定」を参照してください。

// OTSClientConfig オブジェクトを作成します。
public static string Endpoint = "yourEndpoint";
public static string InstanceName = "yourInstance";
public static string AccessKeyId = Environment.GetEnvironmentVariable("OTS_AK_ENV");
public static string AccessKeySecret = Environment.GetEnvironmentVariable("OTS_SK_ENV");
var config = new OTSClientConfig(Endpoint, AccessKeyId, AccessKeySecret, InstanceName);

// ロギングを無効にします。デフォルトでは、ロギングは有効になっています。
config.OTSDebugLogHandler = null;
config.OTSErrorLogHandler = null;

// OTSClientConfig を使用して OtsClient オブジェクトを作成します。
var otsClient = new OTSClient(config);

次の表にパラメーターを示します。

パラメーター

説明

Endpoint

https://myinstance.cn-hangzhou.ots.aliyuncs.com

Tablestore インスタンスにアクセスするために使用されるエンドポイント。詳細については、「Tablestore インスタンスのエンドポイントの取得」を参照してください。

AccessKeyId

Environment.GetEnvironmentVariable("OTS_AK_ENV")

環境変数から取得された AccessKey ペア。環境変数が設定されていることを確認してください。

AccessKeySecret

Environment.GetEnvironmentVariable("OTS_SK_ENV")

InstanceName

myinstance

インスタンスの名前。詳細については、「インスタンス」を参照してください。

APIVersion

2015-12-31

Tablestore プロトコルのバージョン。デフォルト値: 2015-12-31。

ConnectionLimit

300

Tablestore への最大接続数。デフォルト値: 300。

RetryPolicy

DefaultRetryPolicy

再試行ポリシー。デフォルト値: DefaultRetryPolicy。カスタムの再試行ポリシーを指定することもできます。

再試行ポリシーを無効にするには、このパラメーターを null に設定します。

OTSDebugLogHandler

null

デバッグログを処理する関数。通常の要求と応答のログを表示するために使用されます。デフォルト値: defaultOTSDebugLogHandler。

この関数を無効にするには、このパラメーターを null に設定します。

OTSErrorLogHandler

null

エラーログを処理する関数。Tablestore サーバーから返されたエラーのログを表示するために使用されます。デフォルト値: defaultOTSErrorLogHandler。

この関数を無効にするには、このパラメーターを null に設定します。

FAQ

Tablestore SDK を使用するときに Signature mismatch エラーが報告された場合はどうすればよいですか?