初始化

更新时间: 2023-06-30 14:23:28

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

确定Endpoint

Endpoint是阿里云表格存储服务各个实例的域名地址,目前支持下列形式。

示例解释
http://sun.cn-hangzhou.ots.aliyuncs.comHTTP协议,公网网络访问杭州区域的sun实例。
https://sun.cn-hangzhou.ots.aliyuncs.comHTTPS协议,公网网络访问杭州区域的sun实例。
重要 除了公网可以访问外,也支持私网地址。更多信息,请参见服务地址

请按照如下步骤获取实例的Endpoint:

  1. 登录表格存储管理控制台。
  2. 概览页面,单击实例名称。
  3. 实例详情页签的实例访问地址区域即可查看该实例的服务地址(Endpoint)。
    fig_endpoint

配置密钥

要接入阿里云的表格存储服务,您需要拥有一个有效的访问密钥进行签名认证。目前支持下面三种方式:

  • 阿里云账号的AccessKey ID和AccessKey Secret。创建步骤如下:

    1. 在阿里云官网注册阿里云账号

    2. 创建AccessKey ID和AccessKey Secret。具体操作,请参见获取AccessKey

  • 被授予访问表格存储权限的RAM用户的AccessKey ID和AccessKey Secret。创建步骤如下:

    1. 使用阿里云账号前往访问控制RAM,创建一个新的RAM用户或者使用已经存在的RAM用户。

    2. 使用阿里云账号授予RAM用户访问表格存储的权限。

    3. RAM用户被授权后,即可使用自己的AccessKey ID和AccessKey Secret访问。

  • 从STS获取的临时访问凭证。获取步骤如下:

    1. 应用的服务器通过访问RAM/STS服务,获取一个临时的AccessKey ID、AccessKey Secret和SecurityToken发送给使用方。

    2. 使用方使用上述临时密钥访问表格存储服务。

配置环境变量

请根据使用的操作系统执行相应操作配置环境变量。

表格存储使用OTS_AK_ENV环境变量名表示阿里云账号或者RAM用户的AccessKey ID,使用OTS_SK_ENV环境变量名表示对应AccessKey Secret,请根据实际配置。

  • 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系统使配置生效。

初始化对接

获取到AccessKey ID和AccessKey Secret后,您可以按照如下步骤进行初始化对接。

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

    使用示例

    $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>"
    ));
  2. 配置OTSClient。

    如果您需要修改OTSClient的一些默认配置,请在构造OTSClient时传入对应参数,例如代理、连接超时、最大连接数等参数。 具体设置的参数见下表。

    参数

    描述

    默认值

    ConnectionTimeout

    与OTS建立连接的最大延时。

    2.0秒

    StsToken

    临时访问的token。

    null

    SocketTimeout

    每次请求响应最大延时。

    2.0秒,传输量比较大的时候,建议设置大些。

    RetryPolicy

    重试策略。

    DefaultRetryPolicy,设置为null可以关闭。

    ErrorLogHandler

    Error级别日志处理函数,用来打印表格存储服务端返回错误时的日志。

    defaultOTSErrorLogHandler,设置为null可以关闭。

    DebugLogHandler

    Debug级别日志处理函数,用来打印正常的请求和响应信息。

    defaultOTSDebugLogHandler,设置为null可以关闭。

HTTPS

安装OpenSSL PHP扩展即可。

阿里云首页 表格存储 相关技术圈