全部產品
Search
文件中心

:初始化Tablestore Client

更新時間:Jul 17, 2025

Tablestore Client是Tablestore的用戶端,它提供了一系列的方法,可以用來操作Tablestore的表和資料。本文介紹如何在Python中進行Tablestore Client的初始化。

重要

本文以阿里雲帳號的AccessKey為例為您介紹如何初始化Tablestore Client,如果您想使用RAM使用者的存取金鑰或STS臨時訪問憑證進行初始化,請參見使用RAM使用者存取金鑰訪問Table Store使用STS臨時訪問憑證訪問Table Store

準備工作

初始化Tablestore Client前,您需要擷取執行個體的相關資訊、安裝Tablestore SDK並配置訪問憑證。

擷取執行個體資訊

  • 地區ID:執行個體所在地區的ID,例如華東1(杭州)的地區ID為cn-hangzhou。

  • 執行個體名稱和訪問地址:每個Tablestore執行個體對應一個訪問地址(Endpoint),應用程式進行表和資料操作時需要指定訪問地址,擷取方式如下。

    1. 登入Table Store控制台

    2. 在頁面上方,選擇資源群組和地區。

    3. 概覽頁面,單擊執行個體別名或在操作列單擊執行個體管理

    4. 執行個體詳情頁簽,查看執行個體的名稱和訪問地址。

      重要

      新建立的執行個體預設未啟用公網訪問功能。如果您需要通過公網訪問執行個體中的資源,則必須開啟執行個體的公網訪問功能

安裝Tablestore SDK

執行如下命令直接通過pip進行SDK安裝。

sudo pip install tablestore

更多關於安裝Tablestore SDK的資訊,請參見安裝Tablestore SDK

配置訪問憑證

您需要為阿里雲帳號或RAM使用者建立AccessKey,並按如下方式將AccessKey配置到環境變數中。

說明

配置完成後請重啟或重新整理您的編譯運行環境,包括 IDE、命令列介面、其它傳統型應用程式及後台服務,確保最新的系統內容變數成功載入。更多關於配置訪問憑證的資訊,請參見配置訪問憑證

Linux

  1. 在命令列介面執行以下命令來將環境變數設定追加到 ~/.bashrc 檔案中。

    echo "export TABLESTORE_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bashrc
    echo "export TABLESTORE_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bashrc
  2. 執行以下命令使變更生效。

    source ~/.bashrc
  3. 執行以下命令檢查環境變數是否生效。

    echo $TABLESTORE_ACCESS_KEY_ID
    echo $TABLESTORE_ACCESS_KEY_SECRET

macOS

  1. 在終端中執行以下命令,查看預設 Shell 類型。

    echo $SHELL
  2. 根據預設 Shell 類型進行操作。

    Zsh
    1. 執行以下命令來將環境變數設定追加到 ~/.zshrc 檔案中。

      echo "export TABLESTORE_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.zshrc
      echo "export TABLESTORE_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.zshrc
    2. 執行以下命令使變更生效。

      source ~/.zshrc
    3. 執行以下命令檢查環境變數是否生效。

      echo $TABLESTORE_ACCESS_KEY_ID
      echo $TABLESTORE_ACCESS_KEY_SECRET
    Bash
    1. 執行以下命令來將環境變數設定追加到 ~/.bash_profile 檔案中。

      echo "export TABLESTORE_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bash_profile
      echo "export TABLESTORE_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bash_profile
    2. 執行以下命令使變更生效。

      source ~/.bash_profile
    3. 執行以下命令檢查環境變數是否生效。

      echo $TABLESTORE_ACCESS_KEY_ID
      echo $TABLESTORE_ACCESS_KEY_SECRET

Windows

CMD
  1. 在CMD中運行以下命令設定環境變數。

    setx TABLESTORE_ACCESS_KEY_ID "YOUR_ACCESS_KEY_ID"
    setx TABLESTORE_ACCESS_KEY_SECRET "YOUR_ACCESS_KEY_SECRET"
  2. 重啟CMD後,運行以下命令,檢查環境變數是否生效。

    echo %TABLESTORE_ACCESS_KEY_ID%
    echo %TABLESTORE_ACCESS_KEY_SECRET%
PowerShell
  1. 在PowerShell中運行以下命令。

    [Environment]::SetEnvironmentVariable("TABLESTORE_ACCESS_KEY_ID", "YOUR_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User)
    [Environment]::SetEnvironmentVariable("TABLESTORE_ACCESS_KEY_SECRET", "YOUR_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)
  2. 運行以下命令,檢查環境變數是否生效。

    [Environment]::GetEnvironmentVariable("TABLESTORE_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User)
    [Environment]::GetEnvironmentVariable("TABLESTORE_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)

初始化Client

您需要先初始化一個Client,然後調用該Client的方法來訪問Tablestore服務。TablestorePython SDK提供了用戶端OTSClient。

重要

如果要使用HTTPS協議訪問Tablestore資源,推薦您使用Python SDK的最新版本6.x.x,並且確保OpenSSL版本最少為0.9.8j,推薦OpenSSL 1.0.2d。

Table StorePython SDK的發布包中已包含了certifi包,您可以直接安裝使用。如果需要更新根憑證請從根憑證下載最新的根憑證。

寬表模型

以下範例程式碼用於初始化Client,擷取執行個體中的所有資料表名稱並列印到控制台。

# -*- coding: utf-8 -*-
import os
from tablestore import OTSClient

# yourInstanceName 填寫您的執行個體名稱
instance_name = "yourInstanceName"
# yourEndpoint 填寫您的執行個體訪問地址
endpoint = "yourEndpoint"
# 擷取環境變數裡的 AccessKey ID 和 AccessKey Secret
access_key_id = os.getenv("TABLESTORE_ACCESS_KEY_ID")
access_key_secret = os.getenv("TABLESTORE_ACCESS_KEY_SECRET")

# 初始化Table Store用戶端
client = OTSClient(endpoint, access_key_id, access_key_secret, instance_name)

# 列出執行個體中的資料表列表並列印到控制台
resp = client.list_table()
for table_name in resp:
    print(table_name)

時序模型

以下範例程式碼用於初始化Client,擷取執行個體中的所有時序表名稱並列印到控制台。

# -*- coding: utf-8 -*-
import os
from tablestore import OTSClient

# yourInstanceName 填寫您的執行個體名稱
instance_name = "yourInstanceName"
# yourEndpoint 填寫您的執行個體訪問地址
endpoint = "yourEndpoint"
# 擷取環境變數裡的 AccessKey ID 和 AccessKey Secret
access_key_id = os.getenv("TABLESTORE_ACCESS_KEY_ID")
access_key_secret = os.getenv("TABLESTORE_ACCESS_KEY_SECRET")

# 初始化Table Store用戶端
client = OTSClient(endpoint, access_key_id, access_key_secret, instance_name)

# 列出執行個體中的時序表列表並列印到控制台
response = client.list_timeseries_table()
for tableMeta in response:
    print(tableMeta.timeseries_table_name)

您也可以使用Credentials工具讀取存取憑證

常見問題

附錄:使用Credentials工具讀取存取憑證

  1. 執行如下命令安裝alibabacloud_credentials包。

    pip install alibabacloud_credentials
  2. 配置環境變數。

    配置環境變數ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET,分別代表阿里雲帳號的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