初始化OTSClient

重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

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

准备工作

初始化Client前,您需要完成获取实例Endpoint、安装表格存储Node.js SDK和配置访问凭证的准备工作。

获取实例Endpoint

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

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

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

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

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

    1. 登录表格存储控制台

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

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

      image

安装表格存储Node.js SDK

具体操作,请参见安装表格存储Node.js SDK

配置访问凭证

要接入阿里云的表格存储服务,您需要拥有一个有效的访问密钥进行签名认证。具体操作,请参见配置访问凭证

初始化OTSClient

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

示例

警告

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

使用AK初始化

说明

运行本代码示例之前,请确保已设置环境变量OTS_AK_ENVOTS_SK_ENV。更多信息,请参见配置访问凭证

var accessKeyId = process.env.OTS_AK_ENV;
var secretAccessKey = process.env.OTS_SK_ENV;
var endpoint = 'yourEndpoint';
var instancename = 'yourInstance';

var client = new TableStore.Client({
    accessKeyId: accessKeyId,
    secretAccessKey: secretAccessKey,
    endpoint: endpoint,
    instancename: instancename,
    maxRetries:20,//最大重试次数,默认值为20次,可以省略此参数。
});

配置参数说明请参见下表。

参数

示例

说明

endpoint

https://myinstance.cn-hangzhou.ots.aliyuncs.com

实例的访问地址。具体操作,请参见获取实例Endpoint

accessKeyId

process.env.OTS_AK_ENV

通过环境变量获取AccessKey,请确保已配置相应环境变量。

secretAccessKey

process.env.OTS_SK_ENV

instancename

myinstance

实例名称。更多信息,请参见实例

maxRetries

20

出错时最大重试次数。

使用STS初始化

说明

运行本代码示例之前,请确保已设置环境变量OTS_AK_ENVOTS_SK_ENVOTS_SESSION_TOKEN。更多信息,请参见配置访问凭证

var accessKeyId = process.env.OTS_AK_ENV;
var secretAccessKey = process.env.OTS_SK_ENV;
var stsToken = process.env.OTS_SESSION_TOKEN;
var endpoint = 'yourEndpoint';
var instancename = 'yourInstance';

var client = new TableStore.Client({
    accessKeyId: accessKeyId,
    secretAccessKey: secretAccessKey,
    stsToken: stsToken,
    endpoint: endpoint,
    instancename: instancename,
});

配置参数说明请参见下表。

参数

示例

说明

endpoint

https://myinstance.cn-hangzhou.ots.aliyuncs.com

实例的访问地址。具体操作,请参见获取实例Endpoint

accessKeyId

process.env.OTS_AK_ENV

通过环境变量获取AccessKeySTS Token,请确保已配置相应环境变量。

accessKeySecret

process.env.OTS_SK_ENV

stsToken

process.env.OTS_SESSION_TOKEN

instancename

myinstance

实例名称。更多信息,请参见实例

常见问题

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