文档

初始化Client

更新时间:

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

准备工作

初始化Client前,您需要完成配置访问密钥、获取实例Endpoint和安装表格存储Node.js 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

安装表格存储Node.js SDK

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

初始化对接

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

重要

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

  1. 使用表格存储的Endpoint新建Client。

    var OTS_AK_ENV = process.env.OTS_AK_ENV;
    var OTS_SK_ENV = process.env.OTS_SK_ENV;
    var client = new TableStore.Client({
        accessKeyId: OTS_AK_ENV,
        accessKeySecret: OTS_SK_ENV,
        endpoint: '<your endpoint>',
        instancename: '<your instance name>',
        maxRetries:20,//最大重试次数,默认值为20次,可以省略此参数。
    });

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

    参数

    示例

    说明

    endpoint

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

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

    accessKeyId

    process.env.OTS_AK_ENV

    通过环境变量获取AccessKey。

    请确保已配置相应环境变量。具体操作,请参见配置访问密钥

    accessKeySecret

    process.env.OTS_SK_ENV

    instancename

    myinstance

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

  2. 配置Client。

    如果您需要修改Client的一些默认配置,请在构造Client时传入对应参数,例如最大重试次数等参数。 具体设置的参数见下表。

    参数

    说明

    maxRetries

    出错时最大重试次数。默认值为20。

常见问题

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

  • 本页导读 (1)
文档反馈