Tablestore:Python SDK

事前準備

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

バージョン 6.0.0 以降、Python SDK は Python 3 のみをサポートし、Python 2 はサポートされなくなりました。Python 2 を使用するには、バージョン 5.4.4 以前を使用する必要があります。

SDK のインストール

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

pip install tablestore

アクセス認証情報の設定

AccessKey の作成 にて、Alibaba Cloud アカウントまたは RAM ユーザーの AccessKey を作成します。次に、以下に示すように環境変数に 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()

SDK の使用時に「Signature mismatch」エラーが発生した場合はどうすればよいですか？

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

SDK の使用時に「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

SDK の使用時に「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 パッケージをインストールします。

   pip 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