Python SDK

Prerequisites

Download and install the Python runtime environment. Run the python3 --version command to check your Python version.

Starting from version 6.0.0, the Python SDK supports only Python 3 and no longer supports Python 2. To use Python 2, you must use version 5.4.4 or earlier.

Install the SDK

Select an installation method. Use the latest SDK version to ensure code examples run correctly.

pip3 install tablestore

Configure access credentials

Create an AccessKey for your Alibaba Cloud account or RAM user, then configure it as an environment variable to avoid hard-coding credentials.

Restart your IDE, terminal, other desktop applications, and background services after configuration to load the updated environment variables. For more information about other types of access credentials, see Configure access credentials.

Initialize the client

The following code initializes a client and lists all data tables and time series tables in an instance to verify connectivity.

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

import os
import sys
from tablestore import OTSClient

def main():
    try:
        # Get access credentials from environment variables. Ensure TABLESTORE_ACCESS_KEY_ID and TABLESTORE_ACCESS_KEY_SECRET are set.
        access_key_id = os.getenv("TABLESTORE_ACCESS_KEY_ID")
        access_key_secret = os.getenv("TABLESTORE_ACCESS_KEY_SECRET")

        # TODO: Replace the following values with your instance details.
        instance_name = "n01k********"  # Instance name
        endpoint = "https://n01k********.cn-hangzhou.ots.aliyuncs.com"  # Instance endpoint
        
        # Create a client instance.
        client = OTSClient(endpoint, access_key_id, access_key_secret, instance_name)

        # List the data tables.
        resp = client.list_table()

        print(f"Found {len(resp)} data tables in instance '{instance_name}':")
        for table_name in resp:
            print(f"{table_name}")

        # List the time series tables.
        resp = client.list_timeseries_table()

        print(f"\nFound {len(resp)} time series tables in instance '{instance_name}':")
        for tableMeta in resp:
            print(f"{tableMeta.timeseries_table_name}")
            
    except Exception as e:
        print(f"Operation failed: {str(e)}")
        sys.exit(1)


if __name__ == "__main__":
    main()

What do I do if a "Signature mismatch" error occurs?

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

What do I do if a "Request denied by instance ACL policies" error occurs?

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

What do I do if a "Request denied because this instance can only be accessed from the binded VPC" error occurs?

[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

How do I access Tablestore resources over HTTPS?

Use the latest version of the Python SDK. Ensure that your OpenSSL version is 0.9.8j or later. OpenSSL 1.0.2d is recommended.

What do I do if protobuf versions are incompatible?

Some protobuf versions are incompatible with the *pb2.py files in the installation package. To resolve this, regenerate the *pb2.py files:

1. Use your current protoc version to generate code for the proto files.

   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. Rename the generated files with the pb2.py extension and copy them to tablestore/protobuf/ in the installation directory, replacing the original *pb2.py files.

Use the Credentials tool to read access credentials

1. Run the following command to install the alibabacloud_credentials package.

   pip3 install alibabacloud_credentials

2. Configure environment variables.

   Set ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET to the AccessKey ID and AccessKey secret of your Alibaba Cloud account.

3. Read the access credentials.

   The following code reads access credentials from environment variables using the Credentials tool.

   # -*- coding: utf-8 -*-
   from alibabacloud_credentials.client import Client as CredClient
   
   # Use CredClient to get the AccessKey ID and AccessKey secret from the environment variables.
   cred = CredClient()
   access_key_id = cred.get_credential().access_key_id
   access_key_secret = cred.get_credential().access_key_secret