全部产品
Search
文档中心

表格存储:初始化OTSClient

更新时间:Dec 08, 2023

OTSClient是表格存储服务的客户端,它为调用者提供了一系列的方法,可以用来操作表、读写单行数据、读写多行数据等。使用Python SDK发起请求,您需要初始化一个OTSClient实例,并根据需要修改OTSClient的默认配置项。

注意事项

  • 表格存储从Python SDK 2.0.8版本开始支持HTTPS。如果要使用HTTPs协议访问表格存储资源,请使用Python SDK 2.0.8及以上版本,并且确保OpenSSL版本最少为0.9.8j,推荐OpenSSL 1.0.2d。

    Python SDK 2.0.8发布包中包含了certifi包直接安装使用。如果需要更新根证书请从根证书下载最新的根证书。

  • 请在执行功能代码时,确保已引入tablestore包。

准备工作

初始化OTSClient前,您需要完成配置访问密钥、获取实例Endpoint和安装表格存储Python SDK的准备工作。

配置访问密钥

要接入阿里云的表格存储服务,您需要拥有一个有效的访问密钥进行签名认证。目前支持如下三种方式获取AccessKey。为了保证访问密钥安全,请根据使用的操作系统将访问密钥配置到环境变量。

  1. 获取访问密钥。

    重要

    为避免阿里云账号泄露AccessKey带来的安全风险,建议您通过RAM用户来完成授权和AccessKey的创建。

    获取方式

    操作

    阿里云账号的AccessKey ID和AccessKey Secret

    1. 在阿里云官网注册阿里云账号

    2. 创建AccessKey ID和AccessKey Secret。具体操作,请参见创建AccessKey

    被授予访问表格存储权限RAM用户的AccessKey ID和AccessKey Secret

    1. 使用阿里云账号前往访问控制RAM,创建一个新的RAM用户或者使用已经存在的RAM用户。

    2. 使用阿里云账号授予RAM用户访问表格存储的权限。具体操作,请参见通过RAM Policy为RAM用户授权

    3. 为RAM用户授权后,即可使用RAM用户的AccessKey ID和AccessKey Secret访问。具体操作,请参见创建AccessKey

    从STS获取的临时访问凭证

    1. 应用的服务器通过访问RAM/STS服务,获取一个临时的AccessKey ID、AccessKey Secret和SecurityToken发送给使用方。

    2. 使用方使用上述临时密钥访问表格存储服务。

  2. 配置环境变量。

    • Linux和macOS系统配置方法

      执行如下命令配置环境变量。其中<ACCESS_KEY_ID>请替换为已准备好的AccessKey ID,<ACCESS_KEY_SECRET>请替换为对应的AccessKey Secret。

      export OTS_AK_ENV=<ACCESS_KEY_ID>
      export OTS_SK_ENV=<ACCESS_KEY_SECRET>
    • Windows系统配置方法

      新建环境变量文件,并在文件中添加环境变量OTS_AK_ENV和OTS_SK_ENV,然后环境变量分别配置为已准备好的AccessKey ID和AccessKey Secret,最后重启Windows系统使配置生效。

获取实例Endpoint

创建实例后,您需要获取实例域名地址(Endpoint)用于后续通过Endpoint访问实例。

Endpoint是阿里云表格存储服务各个实例的域名地址,例如https://sun.cn-hangzhou.ots.aliyuncs.com,表示使用HTTPS协议通过公网网络访问华东1(杭州)地域的sun实例。更多信息,请参见服务地址

  1. 如果未开通表格存储服务,请进行开通。具体操作,请参见开通表格存储服务

  2. 创建实例。具体操作,请参见创建实例

  3. 创建实例后获取实例的Endpoint。

    1. 登录表格存储控制台

    2. 概览页面,单击实例名称。

    3. 实例详情页签的实例访问地址区域即可查看该实例的服务地址(Endpoint)。

      fig_endpoint

安装表格存储Python SDK

具体操作,请参见安装表格存储Python SDK

初始化对接

使用表格存储的SDK时,您必须首先构造一个OTSClient,通过调用该OTSClient的接口来访问表格存储服务。

重要

阿里云账号AccessKey拥有所有API的访问权限,建议您使用RAM用户进行API访问或日常运维。强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下所有资源的安全。本示例以将AccessKey保存在环境变量中来实现身份验证为例介绍。

接口

"""
初始化``OTSClient``实例。
``end_point``是表格存储服务的地址(例如'https://instance.cn-hangzhou.ots.aliyun.com:80'),必须以'https://'开头。
``access_key_id``是访问表格存储服务的AccessKeyID,通过官方网站申请或通过管理员获取。
``access_key_secret``是访问表格存储服务的AccessKeySecret,通过官方网站申请或通过管理员获取。
``instance_name``是要访问的实例名,通过官方网站控制台创建或通过管理员获取。
``sts_token``是访问表格存储服务的STS token,从阿里云STS服务获取,具有有效期,过期后需要重新获取。
``encoding``请求参数的字符串编码类型,默认值为utf8。
``socket_timeout``是连接池中每个连接的Socket超时,单位为秒,可以为int或float。默认值为50。
``max_connection``是连接池的最大连接数。默认值为50。
``logger_name``用来在请求中打印DEBUG日志,或者在出错时打印ERROR日志。
``retry_policy``定义了重试策略,默认的重试策略为DefaultRetryPolicy。你您可以继承RetryPolicy来实现自己的重试策略,详情请参见DefaultRetryPolicy的代码。
``ssl_version``定义了HTTPS连接使用的TLS版本,默认值为None。
 """
 class OTSClient(object):
    def __init__(self, endpoint, access_key_id, access_key_secret, instance_name, **kwargs): 
      

示例

access_key_id = os.getenv("OTS_AK_ENV")
access_key_secret = os.getenv("OTS_SK_ENV")

#########    设置日志文件名称和重试策略     #########
# 日志文件名称为table_store.log,重试策略是WriteRetryPolicy,会对写重试。
ots_client = OTSClient('endpoint', access_key_id, access_key_secret, 'instance_name', logger_name = 'table_store.log',  retry_policy = WriteRetryPolicy())

#########    设置HTTPS连接所使用的TLS版本为TLSv1.2     #########
# 注意:只有当endpoint使用HTTPS形式时,TLS版本配置才会生效。
ots_client = OTSClient('endpoint', access_key_id, access_key_secret, 'instance_name', ssl_version=ssl.PROTOCOL_TLSv1_2)

#########    使用STS     #########
ots_client = OTSClient('endpoint', 'STS.K8h*******GB77', 'CkuDj******Wn6', 'instance_name', sts_token = 'CAISjgJ1q6Ft5B2y********OFcsLLuw==')                    

引入tablestore包

说明

如果不引入tablestore包,则会出现NameError: name ‘OTSClient’ is not defined提示,请引入tablestore包后运行即可。更多信息,请参见Python SDK ListTable示例

在使用Python SDK调用功能函数时,您必须在代码中引入tablestore包。引入tablestore包的具体代码如下:

# 引入Tablestore包。
from tablestore import *
# 通过环境变量获取AccessKey时需要引入。
import os
# 通过指定TLS版本访问时需要引入。
import ssl

常见问题

使用表格存储SDK时出现Signature mismatch异常