Node.js 向け Tablestore SDK の OTSClient インスタンスの初期化 - Tablestore

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

準備

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

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

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

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

Tablestore サービスがアクティブ化されていない場合は、アクティブ化します。詳細については、Tablestore のアクティブ化を参照してください。
Tablestore インスタンスを作成します。詳細については、インスタンスの作成を参照してください。
作成したインスタンスのエンドポイントを取得します。
1. Tablestore コンソールにログインします。
2. 概要ページで、作成したインスタンスを見つけ、インスタンス名をクリックします。
3. インスタンスアクセス URL セクションの インスタンスの詳細 タブで、インスタンスのエンドポイントを表示します。

Tablestore SDK for Node.js のインストール

詳細については、インストールを参照してください。

アクセス認証情報の設定

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

OTSClient インスタンスの初期化

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

例

警告

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

アクセスキーペアの使用

説明

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

var accessKeyId = process.env.OTS_AK_ENV;
var secretAccessKey = process.env.OTS_SK_ENV;
var endpoint = 'yourEndpoint';
var instancename = 'yourInstance';

var client = new TableStore.Client({
    accessKeyId: accessKeyId,
    secretAccessKey: secretAccessKey,
    endpoint: endpoint,
    instancename: instancename,
    maxRetries:20,// 再試行の最大回数。デフォルト値：20。このパラメータは空のままにすることができます。
});

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

パラメータ	例	説明
endpoint	https://myinstance.cn-hangzhou.ots.aliyuncs.com	Tablestore インスタンスにアクセスするために使用されるエンドポイント。詳細については、Tablestore インスタンスのエンドポイントの取得を参照してください。
accessKeyId	process.env.OTS_AK_ENV	環境変数から取得したアクセスキーペア。環境変数が設定されていることを確認してください。
secretAccessKey	process.env.OTS_SK_ENV	環境変数から取得したアクセスキーペア。環境変数が設定されていることを確認してください。
instancename	myinstance	インスタンスの名前。詳細については、インスタンスを参照してください。
maxRetries	20	エラー発生時に許可される再試行の最大回数。

STS の使用

説明

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

var accessKeyId = process.env.OTS_AK_ENV;
var secretAccessKey = process.env.OTS_SK_ENV;
var stsToken = process.env.OTS_SESSION_TOKEN;
var endpoint = 'yourEndpoint';
var instancename = 'yourInstance';

var client = new TableStore.Client({
    accessKeyId: accessKeyId,
    secretAccessKey: secretAccessKey,
    stsToken: stsToken,
    endpoint: endpoint,
    instancename: instancename,
});

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

パラメータ	例	説明
endpoint	https://myinstance.cn-hangzhou.ots.aliyuncs.com	Tablestore インスタンスにアクセスするために使用されるエンドポイント。詳細については、Tablestore インスタンスのエンドポイントの取得を参照してください。
accessKeyId	process.env.OTS_AK_ENV	環境変数から取得したアクセスキーペアとセキュリティトークン。環境変数が設定されていることを確認してください。
accessKeySecret	process.env.OTS_SK_ENV
stsToken	process.env.OTS_SESSION_TOKEN
instancename	myinstance	インスタンスの名前。詳細については、インスタンスを参照してください。

FAQ

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