Tablestore:Python SDK

前提条件

Python 実行環境をダウンロードしてインストールします。Python のバージョンを確認するには、python3 --version コマンドを実行します。

バージョン 6.0.0 以降では、Python SDK は Python 3 のみをサポートし、Python 2 はサポートされません。Python 2 を使用する場合は、バージョン 5.4.4 以前を使用してください。

SDK のインストール

開発環境に応じて、適切なインストール方法を選択してください。コード例が正しく実行されるよう、最新バージョンの SDK を使用することを推奨します。

pip3 install tablestore

アクセス認証情報の構成

AccessKey の作成を、Alibaba Cloud アカウントまたは RAM ユーザーに対して実行します。その後、以下に示すとおり、環境変数として AccessKey を構成します。環境変数で AccessKey を構成すると、機密情報をコード内にハードコーディングせずに済むため、セキュリティが向上します。

構成が完了したら、開発環境を再起動またはリフレッシュする必要があります。これには、IDE、コマンドラインインターフェイス、その他のデスクトップアプリケーション、およびバックグラウンドサービスが含まれます。これにより、最新のシステム環境変数が読み込まれます。その他の種類のアクセス認証情報については、「アクセス認証情報の構成」をご参照ください。

クライアントの初期化

以下のコードは Tablestore クライアントを初期化し、指定されたインスタンス内のすべてのデータテーブルおよび時系列テーブルを一覧表示することで、接続を検証します。

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

import os
import sys
from tablestore import OTSClient

def main():
    try:
        # 環境変数からアクセス認証情報を取得します。TABLESTORE_ACCESS_KEY_ID および TABLESTORE_ACCESS_KEY_SECRET が設定されていることを確認してください。
        access_key_id = os.getenv("TABLESTORE_ACCESS_KEY_ID")
        access_key_secret = os.getenv("TABLESTORE_ACCESS_KEY_SECRET")

        # TODO: 以下の値をご利用のインスタンスの詳細に置き換えてください。
        instance_name = "n01k********"  # インスタンス名
        endpoint = "https://n01k********.cn-hangzhou.ots.aliyuncs.com"  # インスタンスエンドポイント
        
        # クライアントインスタンスを作成します。
        client = OTSClient(endpoint, access_key_id, access_key_secret, instance_name)

        # データテーブルを一覧表示します。
        resp = client.list_table()

        print(f"インスタンス '{instance_name}' 内で {len(resp)} 個のデータテーブルが見つかりました：")
        for table_name in resp:
            print(f"{table_name}")

        # 時系列テーブルを一覧表示します。
        resp = client.list_timeseries_table()

        print(f"\nインスタンス '{instance_name}' 内で {len(resp)} 個の時系列テーブルが見つかりました：")
        for tableMeta in resp:
            print(f"{tableMeta.timeseries_table_name}")
            
    except Exception as e:
        print(f"操作が失敗しました：{str(e)}")
        sys.exit(1)


if __name__ == "__main__":
    main()

「Signature mismatch」エラーが発生した場合の対処方法を教えてください。

Error Code: OTSAuthFailed, Message: Signature mismatch., RequestId: 0005f55a-xxxx-xxxx-xxxx-xxxxxxxxxxxx, TraceId: 10b0f0e0-xxxx-xxxx-xxxx-xxxxxxxxxxxx, HttpStatus: 403

「Request denied by instance ACL policies」エラーが発生した場合の対処方法を教えてください。

[ErrorCode]:OTSAuthFailed, [Message]:Request denied by instance ACL policies., [RequestId]:XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX, [TraceId]:XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX, [HttpStatus:]403

「Request denied because this instance can only be accessed from the binded VPC」エラーが発生した場合の対処方法を教えてください。

[ErrorCode]:OTSAuthFailed, [Message]:Request denied because this instance can only be accessed from the binded VPC., [RequestId]:XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX, [TraceId]:XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX, [HttpStatus:]403

HTTPS 経由で Tablestore リソースにアクセスするにはどうすればよいですか。

最新バージョンの Python SDK を使用してください。OpenSSL のバージョンが 0.9.8j 以降であることを確認してください。OpenSSL 1.0.2d を推奨します。

protobuf のバージョンが互換性がない場合の対処方法を教えてください。

一部の protobuf バージョンは、現在のインストールパッケージに含まれる *pb2.py ファイルと互換性がありません。この問題を解決するには、*pb2.py ファイルを手動で再生成します：

1. 現在のバージョンの protoc を使用して、対応する proto ファイルから順次コードを生成します。

   protoc --python_out=. tablestore/protobuf/search.proto
   protoc --python_out=. tablestore/protobuf/table_store.proto
   protoc --python_out=. tablestore/protobuf/table_store_filter.proto

2. 生成された 3 つのファイルの拡張子を pb2.py に変更し、インストールディレクトリの tablestore/protobuf/ フォルダにコピーして、元の *pb2.py ファイルを置き換えます。

Credentials ツールを使用してアクセス認証情報を読み込む

1. 以下のコマンドを実行して、alibabacloud_credentials パッケージをインストールします。

   pip3 install alibabacloud_credentials

2. 環境変数を構成します。

   ALIBABA_CLOUD_ACCESS_KEY_ID および ALIBABA_CLOUD_ACCESS_KEY_SECRET 環境変数を、Alibaba Cloud アカウントの AccessKey ID および AccessKey Secret に設定します。

3. アクセス認証情報を読み込みます。

   以下のコードでは、Credentials ツールを使用して環境変数からアクセス認証情報を読み込みます。

   # -*- coding: utf-8 -*-
   from alibabacloud_credentials.client import Client as CredClient
   
   # CredClient を使用して、環境変数から AccessKey ID および AccessKey Secret を取得します。
   cred = CredClient()
   access_key_id = cred.get_credential().access_key_id
   access_key_secret = cred.get_credential().access_key_secret