初始化Tunnel client

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

准备工作

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

获取实例信息

  • 地域ID:实例所在地域的ID,例如华东1(杭州)的地域IDcn-hangzhou。

  • 实例名称和访问地址:每个表格存储实例对应一个访问地址(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

配置访问凭证

您需要为阿里云账号或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)

初始化对接

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

  • 通过阿里云账号或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。