本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。
OTSClient是表格存储服务的客户端,它为调用者提供了一系列的方法,可以用来操作表、读写单行数据、读写多行数据等。使用.NET SDK发起请求,您需要初始化一个OTSClient实例,并根据需要修改OTSClientConfig的默认配置项。
注意事项
表格存储.NET SDK支持使用多线程。使用多线程时,建议共用一个OTSClient对象。
准备工作
初始化OTSClient前,您需要完成获取实例Endpoint、安装表格存储.NET SDK和配置访问凭证的准备工作。
获取实例Endpoint
安装表格存储.NET SDK
配置访问凭证
初始化OTSClient
使用表格存储的SDK时,您必须首先构造一个OTSClient,通过调用该OTSClient的接口来访问表格存储服务。
接口
/// <summary>
/// OTSClient的构造函数。
/// </summary>
/// <param name="endPoint">OTS服务的地址(例如'https://instance.cn-hangzhou.ots.aliyun.com:80'),必须以'https://'开头。</param>
/// <param name="accessKeyID">OTS的Access Key ID,通过官方网站申请。</param>
/// <param name="accessKeySecret">OTS的Access Key Secret,通过官方网站申请。</param>
/// <param name="instanceName">OTS实例名,通过官方网站控制台创建。</param>
public OTSClient(string endPoint, string accessKeyID, string accessKeySecret, string instanceName);
/// <summary>
/// 通过客户端配置OTSClientConfig的实例来创建OTSClient实例。
/// </summary>
/// <param name="config">客户端配置实例</param>
public OTSClient(OTSClientConfig config);
示例
阿里云账号AccessKey拥有所有API的访问权限,建议您使用RAM用户进行API访问或日常运维。强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下所有资源的安全。本示例以将AccessKey、SecurityToken保存在环境变量中来实现身份验证为例介绍。
运行本代码示例之前,请确保已设置环境变量OTS_AK_ENV
和OTS_SK_ENV
。更多信息,请参见配置访问凭证。
// 构造一个OTSClientConfig对象。
public static string Endpoint = "yourEndpoint";
public static string InstanceName = "yourInstance";
public static string AccessKeyId = Environment.GetEnvironmentVariable("OTS_AK_ENV");
public static string AccessKeySecret = Environment.GetEnvironmentVariable("OTS_SK_ENV");
var config = new OTSClientConfig(Endpoint, AccessKeyId, AccessKeySecret, InstanceName);
// 禁止输出日志,默认是打开的。
config.OTSDebugLogHandler = null;
config.OTSErrorLogHandler = null;
// 使用OTSClientConfig创建一个OtsClient对象。
var otsClient = new OTSClient(config);
配置参数说明请参见下表。
参数 | 示例 | 说明 |
Endpoint | https://myinstance.cn-hangzhou.ots.aliyuncs.com | 实例的访问地址。具体操作,请参见获取实例Endpoint。 |
AccessKeyId | Environment.GetEnvironmentVariable("OTS_AK_ENV") | 通过环境变量获取AccessKey,请确保已配置相应环境变量。 |
AccessKeySecret | Environment.GetEnvironmentVariable("OTS_SK_ENV") | |
InstanceName | myinstance | 实例名称。更多信息,请参见实例。 |
APIVersion | 2015-12-31 | OTS协议的版本,默认为"2015-12-31"。 |
ConnectionLimit | 300 | 与OTS建立连接的最大数量。默认值为300。 |
RetryPolicy | DefaultRetryPolicy | 重试策略。默认配置为DefaultRetryPolicy。您也可以自定义重试策略。 如果要关闭重试策略,设置此参数为null即可。 |
OTSDebugLogHandler | null | Debug级别日志处理函数,用来打印正常的请求和响应信息。默认配置为defaultOTSDebugLogHandler。 如果要关闭Debug级别的日志打印,设置此参数为null即可。 |
OTSErrorLogHandler | null | Error级别日志处理函数,用来打印表格存储服务端返回的错误日志。默认配置为defaultOTSErrorLogHandler。 如果要关闭Error级别的日志打印,设置此参数为null即可。 |