初始化Tunnel client

Tunnel client是通道服务的客户端,它为调用者提供了一系列的方法,可以用来操作通道、消费数据等。如果要使用通道服务消费表中的数据,您需要初始化一个Tunnel client。

准备工作

初始化Tunnel Client前,您需要获取实例的相关信息、安装Tablestore Go SDK并配置访问凭证。

获取实例信息

  • 地域ID:实例所在的地域ID,例如华东1(杭州)的地域IDcn-hangzhou,更多地域信息请参见地域

  • 实例名称和服务地址Endpoint:每个表格存储实例对应一个服务地址(Endpoint),应用程序进行表和数据操作时需要指定服务地址,获取方式如下。

    1. 登录表格存储控制台

    2. 在页面上方,选择资源组和地域。

    3. 概览页面,单击实例别名或在操作列单击实例管理

    4. 实例详情页签,查看实例的名称和服务地址。

安装Tablestore SDK

在项目目录中执行go mod init <DIRNAME>命令生成go.mod文件后,执行如下命令安装表格存储Go SDK。

说明

<DIRNAME>为项目目录路径,请以实际路径为准。

go get github.com/aliyun/aliyun-tablestore-go-sdk/tablestore

更多关于安装Tablestore SDK的信息,请参见安装Tablestore SDK

配置访问凭证

使用Tablestore SDK发起请求访问表格存储,您需要配置访问凭证,阿里云服务会通过访问凭证验证您的身份信息和访问权限。

本文以阿里云账号的AccessKey为例为您介绍如何配置访问凭证。AccessKey的获取方式,请参见如何获取AccessKey

直接在代码中保存访问凭证容易导致信息泄露,建议您将访问凭证保存在系统环境变量中。

Windows

以管理员身份运行命令提示符,执行以下命令。

# 配置 AccessKey ID
setx TABLESTORE_ACCESS_KEY_ID your_access_key_id /m
# 配置 AccessKey Secret
setx TABLESTORE_ACCESS_KEY_SECRET your_access_key_secret /m

macOS/Linux/Unix

# 配置 AccessKey ID
export TABLESTORE_ACCESS_KEY_ID=your_access_key_id
# 配置 AccessKey Secret
export TABLESTORE_ACCESS_KEY_SECRET=your_access_key_secret

更多关于配置访问凭证的信息,请参见配置访问凭证

初始化对接

请根据实际场景选择相应方式进行初始化。

  • 通过阿里云账号或RAM用户的AccessKey进行初始化

    重要

    出于安全考虑,强烈建议您通过RAM用户使用表格存储功能。您可以创建RAM用户、授予该用户管理表格存储权限( AliyunOTSFullAccess )并为该RAM用户创建AccessKey。具体操作,请参见使用RAM用户访问密钥访问表格存储

    获取到AccessKey IDAccessKey Secret后,您可以按照如下示例代码初始化Tunnel client。

    //instanceName是实例名称。
    //endPoint是表格存储实例endPoint,例如https://instance.cn-hangzhou.ots.aliyun.com。
    //accessKeyIdaccessKeySecret分别为阿里云账号或者RAM用户的AccessKey IDAccessKey Secret。
    instanceName := "yourInstanceName"
    endPoint := "yourEndpoint"
    accessKeyId := os.Getenv("TABLESTORE_ACCESS_KEY_ID")
    accessKeySecret := os.Getenv("TABLESTORE_ACCESS_KEY_SECRET")
    tunnelClient := tunnel.NewTunnelClient(endPoint, instanceName, accessKeyId, accessKeySecret)                    
  • 通过从STS获取的临时访问凭证进行初始化

    如果要进行临时访问授权,请使用此方式进行初始化。

    说明

    如何获取STS临时访问凭证信息,请参见使用STS临时访问凭证访问表格存储

    Tunnel client内提供了NewTunnelClientWithToken接口用于使用临时访问凭证初始化Tunnel client。