初始化OTSClient
OTSClient是表格存储服务的客户端,它为调用者提供了一系列的方法,可以用来操作表、读写单行数据、读写多行数据等。使用PHP SDK发起请求,您需要初始化一个OTSClient实例,并根据需要修改OTSClientConfig的默认配置项。
注意事项
如果要使用HTTPs协议访问表格存储资源,请安装OpenSSL PHP扩展。
准备工作
初始化OTSClient前,您需要完成配置访问密钥、获取实例Endpoint和安装表格存储PHP SDK的准备工作。
配置访问密钥
要接入阿里云的表格存储服务,您需要拥有一个有效的访问密钥进行签名认证。目前支持如下三种方式获取AccessKey。为了保证访问密钥安全,请根据使用的操作系统将访问密钥配置到环境变量。
获取访问密钥。
重要为避免阿里云账号泄露AccessKey带来的安全风险,建议您通过RAM用户来完成授权和AccessKey的创建。
获取方式
操作
阿里云账号的AccessKey ID和AccessKey Secret
在阿里云官网注册阿里云账号。
创建AccessKey ID和AccessKey Secret。具体操作,请参见获取AccessKey。
被授予访问表格存储权限RAM用户的AccessKey ID和AccessKey Secret
使用阿里云账号前往访问控制RAM,创建一个新的RAM用户或者使用已经存在的RAM用户。
使用阿里云账号授予RAM用户访问表格存储的权限。具体操作,请参见通过RAM Policy为RAM用户授权。
为RAM用户授权后,即可使用RAM用户的AccessKey ID和AccessKey Secret访问。具体操作,请参见获取AccessKey。
从STS获取的临时访问凭证
应用的服务器通过访问RAM/STS服务,获取一个临时的AccessKey ID、AccessKey Secret和SecurityToken发送给使用方。
使用方使用上述临时密钥访问表格存储服务。
配置环境变量。
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实例。更多信息,请参见服务地址。
安装表格存储PHP SDK
具体操作,请参见安装表格存储PHP SDK。
初始化对接
使用表格存储的SDK时,您必须首先构造一个OTSClient,通过调用该OTSClient的接口来访问表格存储服务。
阿里云账号AccessKey拥有所有API的访问权限,建议您使用RAM用户进行API访问或日常运维。强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下所有资源的安全。本示例以将AccessKey保存在环境变量中来实现身份验证为例介绍。
使用表格存储的Endpoint新建OTSClient。
$accessKeyId = getenv('OTS_AK_ENV'); $accessKeySecret = getenv('OTS_SK_ENV'); $otsClient = new Aliyun\OTS\OTSClient(array( 'EndPoint' => "<your endpoint>", 'AccessKeyID' => $accessKeyId, 'AccessKeySecret' => $accessKeySecret, 'InstanceName' => "<your instance name>" ));
配置参数说明请参见下表。
参数
示例
说明
EndPoint
https://myinstance.cn-hangzhou.ots.aliyuncs.com
实例的访问地址。具体操作,请参见获取实例Endpoint。
AccessKeyID
getenv('OTS_AK_ENV')
通过环境变量获取AccessKey。
请确保已配置相应环境变量。具体操作,请参见配置访问密钥。
AccessKeySecret
getenv('OTS_SK_ENV')
InstanceName
myinstance
实例名称。更多信息,请参见实例。
配置OTSClient。
如果您需要修改OTSClient的一些默认配置,请在构造OTSClient时传入对应参数,例如代理、连接超时、最大连接数等参数。 具体设置的参数见下表。
参数
描述
ConnectionTimeout
与OTS建立连接的最大延时。默认值为2.0秒。
StsToken
临时访问的token。
当使用从STS获取的临时访问凭证访问表格存储服务时,需要配置此参数。关于使用临时访问凭证的具体操作,请参见使用临时访问凭证。
SocketTimeout
每次请求响应最大延时。默认值为2.0秒。
当传输量比较大时,建议将此参数值设置的大些。
RetryPolicy
重试策略。默认配置为DefaultRetryPolicy。
如果要关闭重试策略,设置此参数为null即可。
ErrorLogHandler
Error级别日志处理函数,用来打印表格存储服务端返回错误时的日志。默认配置为defaultOTSErrorLogHandler。
如果要关闭Error级别的日志打印,设置此参数为null即可。
DebugLogHandler
Debug级别日志处理函数,用来打印正常的请求和响应信息。默认配置为defaultOTSDebugLogHandler。
如果要关闭Debug级别的日志打印,设置此参数为null即可。