初始化客户端（PHP SDK）--对象存储-火山引擎

文档中心

立即注册

导航

对象存储

初始化客户端（PHP SDK）

最近更新时间：2024.09.05 17:26:15首次发布时间：2022.11.16 14:58:44

TosClient 是 TOS 的 PHP 客户端，提供了一系列接口用来与 TOS 服务进行交互，以管理存储桶和对象等 TOS 服务上的资源。

前提条件

配置长期访问凭证

初始化 SDK 前，您需要先配置长期访问凭证。本章节介绍不同操作系统下配置长期访问凭证的操作步骤。

macOS

Linux

Windows

打开终端并执行以下命令打开文件。

nano ~/.bash_profile

在文件末尾添加 AKSK 信息。

export TOS_ACCESS_KEY=AKTPYmI1Z****
export TOS_SECRET_KEY=T1dJM01UU****

保存文件并退出。
执行以下命令生效配置信息。

source ~/.bash_profile

执行以下命令验证配置信息。

echo $TOS_ACCESS_KEY
echo $TOS_SECRET_KEY

如果配置成功，则返回如下示例：

AKTPYmI1Z****
T1dJM01UU****

打开终端并执行以下命令打开文件。

sudo vim /etc/profile

在文件末尾添加 AKSK 信息。

export TOS_ACCESS_KEY=AKTPYmI1Z****
export TOS_SECRET_KEY=T1dJM01UU****

保存文件并退出。
执行以下命令生效配置信息。

source /etc/profile

执行以下命令验证配置信息。

echo $TOS_ACCESS_KEY
echo $TOS_SECRET_KEY

如果配置成功，则返回如下示例：

AKTPYmI1Z****
T1dJM01UU****

打开命令行工具，执行以下命令，添加 AKSK 信息。

set TOS_ACCESS_KEY=AKTPYmI1Z****
set TOS_SECRET_KEY=T1dJM01UU****

执行以下命令生效配置信息。

setx TOS_ACCESS_KEY "%TOS_ACCESS_KEY%"
setx TOS_SECRET_KEY "%TOS_SECRET_KEY%"

重启命令行工具，然后执行以下命令验证配置信息。

echo %TOS_ACCESS_KEY%
echo %TOS_SECRET_KEY%

如果配置成功，则返回如下示例：

AKTPYmI1Z****
T1dJM01UU****

创建 TosClient

通过 Region 和 Endpoint 创建

说明

Endpoint 为 TOS 对外服务的访问域名。TOS 支持的 Endpoint 信息，请参见访问域名 Endpoint。
AKSK 信息可从环境变量获取，配置方式，请参见配置访问凭证。

<?php

// 假设使用 composer 安装
require_once __DIR__ . '/vendor/autoload.php';

use Tos\TosClient;

$region = 'your region';
$endpoint = 'your endpoint';

// 从环境变量中获取访问密钥
$ak = getenv('TOS_ACCESS_KEY'); 
$sk = getenv('TOS_SECRET_KEY'); 

try {
    $client = new TosClient([
        'region' => $region,
        'endpoint' => $endpoint,
        'ak' => $ak,
        'sk' => $sk,
    ]);
} catch (\RuntimeException $ex) {
    echo 'create TosClient failed, message: ' . $ex->getMessage() . PHP_EOL;
}

使用 STS 创建

<?php

// 假设使用 composer 安装
require_once __DIR__ . '/vendor/autoload.php';

use Tos\TosClient;

$region = 'your region';
$endpoint = 'your endpoint';
$ak = 'your access key';
$sk = 'your secret key';
$securityToken = 'your security token';

try {
    $client = new TosClient([
        'region' => $region,
        'endpoint' => $endpoint,
        'ak' => $ak,
        'sk' => $sk,
        'securityToken' => $securityToken
    ]);
} catch (\RuntimeException $ex) {
    echo 'create TosClient failed, message: ' . $ex->getMessage() . PHP_EOL;
}

配置初始化参数

您可通过初始化参数在创建 TosClient 时对 TosClient 进行配置。支持配置的参数请参见下表。

参数名	参数类型	是否必选	示例值	说明
region	String	必选	cn-beijing	TOS 服务端所在区域。
endpoint	String	可选，为空时由 `region` 参数决定	https://tos-cn-beijing.volces.com/	TOS 服务端域名，如果没有指定协议，默认使用 HTTPS 协议，完整格式：`https://{host}:{port}` 。
ak	String	对于普通桶必选，如果桶可以匿名访问，则可选	AKTPYmI1ZGQwMDA0NjlhNGFkMzhjNzM0N2Q0OTQ3ZTV****	访问密钥中的 Access Key ID。
sk	String	对于普通桶必选，如果桶可以匿名访问，则可选	T1dJM01UUXpOak0wTVdWak5EUmtOR0poWldJNU1HWmxaV1V5TkdReVl6****	访问密钥中的 Secret Access Key。
securityToken	String	可选	3ZDA5MjY4NWYwMDQyYThlIiwiU2Vzc2lvbk5hbWUiOiJ0b3Nfcm9sZV9z************	临时授权的 STS。
connectionTimeout	float	可选	30000	建立连接超时时间，单位：毫秒，默认 10000 毫秒。
socketTimeout	float	可选	60000	Socket 读写超时时间，单位：毫秒，默认 30000 毫秒。
enableVerifySSL	bool	可选	true	是否开启 SSL 证书校验，默认为 true。