对象存储快速入门（PHP SDK）

一、相关资源

·对象存储 COS 的 XML PHP SDK 源码下载地址：XML PHP SDK。

·SDK 快速下载地址：XML PHP SDK。

·示例 Demo 程序地址：PHP sample。

·SDK 文档中的所有示例代码请参见 SDK 代码示例。

·SDK 更新日志请参见 CHANGELOG。

·SDK 常见问题请参见：PHP SDK 常见问题。

注意：说明：

注意：如果你在使用 XML 版本 SDK 时遇到函数或方法不存在等错误，请先将 XML 版本 SDK 升级到最新版再重试。如果你仍在使用 JSON 版本 SDK，请升级到 XML PHP SDK。

二、环境配置与准备

·版本说明：PHP 5.6及以上。

·所需扩展包：cURL 扩展、xml 扩展、dom 扩展、mbstring 扩展、json 扩展。

注意：说明：

注意：sudo apt-get install php-curl php-xml php-dom php-mbstring php-json

注意：sudo yum install php-curl php-xml php-dom php-mbstring php-json

三、安装 SDK

SDK 安装有三种方式：Composer 方式、Phar 方式和源码方式。

Composer 方式Phar 方式源码方式

推荐使用 Composer 安装 cos-php-sdk-v5，Composer 是 PHP 的依赖管理工具，允许你声明项目所需的依赖，然后自动将它们安装到你的项目中。

注意：说明：

注意：你可以在 Composer 页面上找到更多关于如何安装 Composer，配置自动加载以及用于定义依赖项的其他最佳实践等相关信息。

1. 打开终端。

2. 执行以下命令，下载 Composer。

curl -sS https://getcomposer.org/installer | php

3. 创建一个名为 composer.json 的文件，内容如下。

{ "require": { "qcloud/cos-sdk-v5": ">=2.0" }}

4. 执行以下命令，使用 Composer 安装。

php composer.phar install

使用该命令后会在当前目录中创建一个 vendor 文件夹，里面包含 SDK 的依赖库和一个 autoload.php 脚本，方便在项目中调用。

注意：目前已支持 Composer 根据当前 PHP 版本下载 Guzzle6 或 Guzzle7。Guzzle7 版本支持 laravel8 框架。当 PHP 版本为7.2.5及以上时自动下载 Guzzle7 版本，反之下载 Guzzle6 版本。

5. 通过 autoloader 脚本调用 cos-php-sdk-v5，在代码中引入 autoload.php 文件。

require '/path/to/sdk/vendor/autoload.php';

四、Running Environment

Operating System: Ubuntu 24.04.3 LTS / x86_64Runtime Version: PHP 8.3.6 (cli) (built: Jul 14 2025 18:30:55) (NTS)

注意：执行 composer 安装后，这里的路径需更改为 autoload.php 文件所对应的路径，否则会调用不到相关方法。如你安装的路径为/Users/username/project，则项目中引用的路径应填写为/Users/username/project/vendor/autoload.php。

至此，你的项目已经可以使用 COS XML PHP SDK 了。

1. 在 GitHub 发布页面下载相应的 phar 文件。

注意：说明：

2. 在代码中引入 phar 文件。

require '/path/to/cos-sdk-v5-x.phar';

1. 在 SDK 下载页面下载 cos-sdk-v5.tar.gz 压缩文件。

注意：说明：

2. 解压后通过 autoload.php 脚本加载 SDK，在代码中引入 autoload.php 文件。

require '/path/to/sdk/vendor/autoload.php';

注意：Source code 压缩包为 GitHub 默认打包的代码包，里面不包含 vendor 目录。请注意下载 release 包（cos-sdk-v5-x.tar.gz 包）而不是 Source 包，也不要直接 clone 整个仓库。否则会缺失 index.php 以及 vendor 包。

五、初始化 COS 服务

下面为你介绍如何使用 COS PHP SDK 完成初始化客户端、创建存储桶、查询存储桶列表、上传对象、查询对象列表、下载对象和删除对象。关于示例中的参数说明，请参见存储桶操作和对象操作文档。

六、初始化 COS

临时密钥永久密钥

若你使用临时密钥初始化，请使用以下方式创建实例。

$tmpSecretId = "TmpSecretId"; //临时密钥的 SecretId，临时密钥生成和使用指引参见 https://cloud.tencent.com/document/product/436/14048$tmpSecretKey = "TmpSecretKey"; //临时密钥的 SecretKey，临时密钥生成和使用指引参见 https://cloud.tencent.com/document/product/436/14048$tmpToken = "TmpToken"; //临时密钥的 Token，临时密钥生成和使用指引参见 https://cloud.tencent.com/document/product/436/14048$region = "ap-beijing"; //替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.cloud.tencent.com/cos5/bucket$cosClient = new Qcloud\\Cos\\Client( array( 'region' => $region, 'scheme' => 'https', //协议头部，默认为http 'credentials'=> array( 'secretId' => $tmpSecretId, 'secretKey' => $tmpSecretKey, 'token' => $tmpToken)));

七、Running Environment

Operating System: Ubuntu 24.04.3 LTS / x86_64Runtime Version: PHP 8.3.6 (cli) (built: Jul 14 2025 18:30:55) (NTS)

若你使用永久密钥初始化 COSClient，可以先在访问管理控制台中的 API 密钥管理页面获取 SecretId、SecretKey，使用永久密钥适用于大部分的应用场景。// SECRETID 和 SECRETKEY 请登录访问管理控制台进行查看和管理$secretId = getenv('COS_SECRET_ID'); //用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参考https://cloud.tencent.com/document/product/598/37140$secretKey = getenv('COS_SECRET_KEY'); //用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参考https://cloud.tencent.com/document/product/598/37140$region = "ap-beijing"; //用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.cloud.tencent.com/cos5/bucket$cosClient = new Qcloud\\Cos\\Client( array( 'region' => $region, 'scheme' => 'https', //协议头部，默认为 http 'credentials'=> array( 'secretId' => $secretId , 'secretKey' => $secretKey)));

注意：若未配置 HTTPS 证书，则需要删除 scheme 参数或填入 'scheme' => 'http'；若填入 https 会出现 certificate problem。若你需要配置证书，可参见 PHP SDK 常见问题。

八、访问 COS 服务

创建存储桶查询存储桶列表上传对象查询对象列表下载对象删除对象

用户确定地域和存储桶名称后，参考如下示例创建存储桶。关于创建存储桶的完整示例，请前往 GitHub 查看。require dirname(__FILE__) . '/../vendor/autoload.php';$secretId = getenv('COS_SECRET_ID'); //用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参考 https://cloud.tencent.com/document/product/598/37140$secretKey = getenv('COS_SECRET_KEY'); //用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参考 https://cloud.tencent.com/document/product/598/37140$region = getenv('COS_REGION'); //用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.cloud.tencent.com/cos5/bucket$cosClient = new Qcloud\\Cos\\Client( array( 'region' => $region, 'scheme' => 'https', //协议头部，默认为 http 'credentials'=> array( 'secretId' => $secretId, 'secretKey' => $secretKey)));try { $bucket = "examplebucket-1250000000"; //存储桶名称格式：BucketName-APPID $result = $cosClient->createBucket(array('Bucket' => $bucket)); //请求成功 print_r($result);} catch (\\Exception $e) { //请求失败 echo($e);}

查询用户的存储桶列表，参考如下示例。关于查询存储桶列表的完整示例，请前往 GitHub 查看。require dirname(__FILE__) . '/../vendor/autoload.php';$secretId = getenv('COS_SECRET_ID'); //用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参考 https://cloud.tencent.com/document/product/598/37140$secretKey = getenv('COS_SECRET_KEY'); //用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参考 https://cloud.tencent.com/document/product/598/37140$region = getenv('COS_REGION'); //用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.cloud.tencent.com/cos5/bucket$cosClient = new Qcloud\\Cos\\Client( array( 'region' => $region, 'scheme' => 'https', //协议头部，默认为 http 'credentials'=> array( 'secretId' => $secretId, 'secretKey' => $secretKey)));try { //请求成功 $result = $cosClient->listBuckets(); // 打印存储桶列表信息 if (isset($result['Buckets'])) { foreach ($result['Buckets'] as $bucket) { echo "BucketName: " . $bucket['Name'] . "\\n"; echo "Location: " . $bucket['Location'] . "\\n"; echo "CreationDate: " . $bucket['CreationDate'] . "\\n"; echo "—\\n"; } }} catch (\\Exception $e) { //请求失败 echo($e);}

关于上传对象的完整示例，请前往 GitHub 查看。

require dirname(__FILE__) . '/../vendor/autoload.php';$secretId = getenv('COS_SECRET_ID'); //用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参考 https://cloud.tencent.com/document/product/598/37140$secretKey = getenv('COS_SECRET_KEY'); //用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参考 https://cloud.tencent.com/document/product/598/37140$region = getenv('COS_REGION'); //用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.cloud.tencent.com/cos5/bucket$cosClient = new Qcloud\\Cos\\Client( array( 'region' => $region, 'scheme' => 'https', //协议头部，默认为 http 'credentials'=> array( 'secretId' => $secretId, 'secretKey' => $secretKey)));# 上传文件## putObject(上传接口，最大支持上传5G文件)### 上传内存中的字符串try { $bucket = "examplebucket-1250000000"; //存储桶名称格式：BucketName-APPID $key = "exampleobject"; //此处的 key 为对象键，对象键是对象在存储桶中的唯一标识 $result = $cosClient->putObject(array( 'Bucket' => $bucket, 'Key' => $key, 'Body' => 'Hello World!')); print_r($result);} catch (\\Exception $e) { echo "$e\\n";}### 上传文件流try { $bucket = "examplebucket-1250000000"; //存储桶名称格式：BucketName-APPID $key = "exampleobject"; //此处的 key 为对象键，对象键是对象在存储桶中的唯一标识 $srcPath = "path/to/localFile";//本地文件绝对路径 $file = fopen($srcPath, "rb"); if ($file) { $result = $cosClient->putObject(array( 'Bucket' => $bucket, 'Key' => $key, 'Body' => $file)); print_r($result); }} catch (\\Exception $e) { echo "$e\\n";}## Upload(高级上传接口，默认使用分块上传最大支持50T)### 上传内存中的字符串try { $bucket = "examplebucket-1250000000"; //存储桶名称格式：BucketName-APPID $key = "exampleobject"; //此处的 key 为对象键，对象键是对象在存储桶中的唯一标识 $result = $cosClient->Upload( $bucket = $bucket, $key = $key, $body = 'Hello World!'); print_r($result);} catch (\\Exception $e) { echo "$e\\n";}### 上传文件流try { $bucket = "examplebucket-1250000000"; //存储桶名称格式：BucketName-APPID $key = "exampleobject"; //此处的 key 为对象键，对象键是对象在存储桶中的唯一标识 $srcPath = "path/to/localFile";//本地文件绝对路径 $file = fopen($srcPath, 'rb'); if ($file) { $result = $cosClient->Upload( $bucket = $bucket, $key = $key, $body = $file); } print_r($result);} catch (\\Exception $e) { echo "$e\\n";}

查询存储桶中对象列表，参考如下示例。关于查询对象列表的完整示例，请前往 GitHub 查看。

九、Running Environment

Operating System: Ubuntu 24.04.3 LTS / x86_64Runtime Version: PHP 8.3.6 (cli) (built: Jul 14 2025 18:30:55) (NTS)

单次调用 listObjects 接口只能查询1000个对象，如需要查询所有的对象，则需要循环调用。

上传对象后，你可以用同样的 key，调用 GetObject 接口将对象下载到本地，也可以生成预签名链接（下载请指定 method 为 GET，详情请参见预签名 URL），分享到其他终端来进行下载。但如果你的文件设置了私有读权限，那么请注意预签名链接的有效期。将文件下载到本地指定路径，参考如下示例。关于下载对象的完整示例，请前往 GitHub 查看。require dirname(__FILE__) . '/../vendor/autoload.php';$secretId = getenv('COS_SECRET_ID'); //用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参考 https://cloud.tencent.com/document/product/598/37140$secretKey = getenv('COS_SECRET_KEY'); //用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参考 https://cloud.tencent.com/document/product/598/37140$region = getenv('COS_REGION'); //用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.cloud.tencent.com/cos5/bucket$cosClient = new Qcloud\\Cos\\Client( array( 'region' => $region, 'scheme' => 'https', //协议头部，默认为 http 'credentials'=> array( 'secretId' => $secretId, 'secretKey' => $secretKey)));# 下载文件## getObject(下载文件)### 下载到内存try { $bucket = "examplebucket-1250000000"; //存储桶，格式：BucketName-APPID $key = "exampleobject"; //此处的 key 为对象键，对象键是对象在存储桶中的唯一标识 $result = $cosClient->getObject(array( 'Bucket' => $bucket, 'Key' => $key)); // 请求成功 echo($result['Body']);} catch (\\Exception $e) { // 请求失败 echo "$e\\n";}### 下载到本地try { $bucket = "examplebucket-1250000000"; //存储桶，格式：BucketName-APPID $key = "exampleobject"; //此处的 key 为对象键，对象键是对象在存储桶中的唯一标识 $localPath = @"path/to/localFile";//下载到本地指定路径 $result = $cosClient->getObject(array( 'Bucket' => $bucket, 'Key' => $key, 'SaveAs' => $localPath));} catch (\\Exception $e) { // 请求失败 echo "$e\\n";}### 指定下载范围/* * Range 字段格式为 'bytes=a-b' */try { $bucket = "examplebucket-1250000000"; //存储桶，格式：BucketName-APPID $key = "exampleobject"; //此处的 key 为对象键，对象键是对象在存储桶中的唯一标识 $localPath = @"path/to/localFile";//下载到本地指定路径 $result = $cosClient->getObject(array( 'Bucket' => $bucket, 'Key' => $key, 'Range' => 'bytes=0-10', 'SaveAs' => $localPath));} catch (\\Exception $e) { // 请求失败 echo "$e\\n";}## getObjectUrl(获取文件 UrL)try { $bucket = "examplebucket-1250000000"; //存储桶，格式：BucketName-APPID $key = "exampleobject"; //此处的 key 为对象键，对象键是对象在存储桶中的唯一标识 $signedUrl = $cosClient->getObjectUrl($bucket, $key, '+10 minutes'); // 请求成功 echo $signedUrl;} catch (\\Exception $e) { // 请求失败 print_r($e);}

注意：对象被删除后，其对应的数据将无法再被访问。删除 COS 上指定路径的对象，参考如下示例代码。关于删除对象的完整示例，请前往 GitHub 查看。# 删除 object## deleteObjecttry { $bucket = "examplebucket-1250000000"; //存储桶，格式：BucketName-APPID $key = "exampleobject"; //此处的 key 为对象键，对象键是对象在存储桶中的唯一标识 $result = $cosClient->deleteObject(array( 'Bucket' => $bucket, 'Key' => $key, 'VersionId' => 'string' )); // 请求成功 print_r($result);} catch (\\Exception $e) { // 请求失败 echo($e);}# 删除多个 object## deleteObjectstry { $bucket = "examplebucket-1250000000"; //存储桶，格式：BucketName-APPID $key1 = "exampleobject1"; //此处的 key 为对象键，对象键是对象在存储桶中的唯一标识 $key2 = "exampleobject2"; //此处的 key 为对象键，对象键是对象在存储桶中的唯一标识 $result = $cosClient->deleteObjects(array( 'Bucket' => $bucket, 'Objects' => array( array( 'Key' => $key1, ), array( 'Key' => $key2, ), //… ), )); // 请求成功 print_r($result);} catch (\\Exception $e) { // 请求失败 echo($e);}

十、常见问题

你在使用过程中可能会碰到的一些常见问题，相关的解决办法可参见 PHP SDK 常见问题。

对象存储 快速入门（PHP SDK）

一、相关资源

二、环境配置与准备

三、安装 SDK

四、Running Environment

五、初始化 COS 服务

六、初始化 COS

七、Running Environment

八、访问 COS 服务

九、Running Environment

十、常见问题

相关内容：

对象存储快速入门（PHP SDK）