tencent cloud

Cloud Object Storage

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Overview
Features
Use Cases
Strengths
Concepts
Regions and Access Endpoints
Specifications and Limits
Service Regions and Service Providers
Billing
Billing Overview
Billing Method
Billable Items
Free Tier
Billing Examples
Viewing and Downloading Bill
Payment Overdue
FAQs
Getting Started
Console
Getting Started with COSBrowser
User Guide
Creating Request
Bucket
Object
Data Management
Batch Operation
Global Acceleration
Monitoring and Alarms
Operations Center
Data Processing
Content Moderation
Smart Toolbox
Data Processing Workflow
Application Integration
User Tools
Tool Overview
Installation and Configuration of Environment
COSBrowser
COSCLI (Beta)
COSCMD
COS Migration
FTP Server
Hadoop
COSDistCp
HDFS TO COS
GooseFS-Lite
Online Tools
Diagnostic Tool
Use Cases
Overview
Access Control and Permission Management
Performance Optimization
Accessing COS with AWS S3 SDK
Data Disaster Recovery and Backup
Domain Name Management Practice
Image Processing
Audio/Video Practices
Workflow
Direct Data Upload
Content Moderation
Data Security
Data Verification
Big Data Practice
COS Cost Optimization Solutions
Using COS in the Third-party Applications
Migration Guide
Migrating Local Data to COS
Migrating Data from Third-Party Cloud Storage Service to COS
Migrating Data from URL to COS
Migrating Data Within COS
Migrating Data Between HDFS and COS
Data Lake Storage
Cloud Native Datalake Storage
Metadata Accelerator
GooseFS
Data Processing
Data Processing Overview
Image Processing
Media Processing
Content Moderation
File Processing Service
File Preview
Troubleshooting
Obtaining RequestId
Slow Upload over Public Network
403 Error for COS Access
Resource Access Error
POST Object Common Exceptions
API Documentation
Introduction
Common Request Headers
Common Response Headers
Error Codes
Request Signature
Action List
Service APIs
Bucket APIs
Object APIs
Batch Operation APIs
Data Processing APIs
Job and Workflow
Content Moderation APIs
Cloud Antivirus API
SDK Documentation
SDK Overview
Preparations
Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Flutter SDK
Go SDK
iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
React Native SDK
Mini Program SDK
Error Codes
Harmony SDK
Endpoint SDK Quality Optimization
Security and Compliance
Data Disaster Recovery
Data Security
Cloud Access Management
FAQs
Popular Questions
General
Billing
Domain Name Compliance Issues
Bucket Configuration
Domain Names and CDN
Object Operations
Logging and Monitoring
Permission Management
Data Processing
Data Security
Pre-signed URL Issues
SDKs
Tools
APIs
Agreements
Service Level Agreement
Privacy Policy
Data Processing And Security Agreement
Contact Us
Glossary

Getting Started

PDF
Mode fokus
Ukuran font
Terakhir diperbarui: 2025-11-20 12:54:12

Download and Installation

Relevant resources

Download the source code for the COS XML PHP SDK here.
Download the XML PHP SDK here.
Download the PHP demo here.
For the complete sample code, see SDK Sample Code.
For the SDK changelog, see Changelog.
For SDK FAQs, see PHP SDK FAQs.
Note:
If you encounter errors such as non-existent functions or methods when using the XML version of the SDK, please update the SDK to the latest version and try again.

Environmental dependencies

PHP 5.6+ You can run the php -v command to view the current PHP version.
Note:
If your PHP version is 5.3 or later and earlier than 5.6, please use v1.3.
cURL extension
XML extension
DOM extension
MBstring extension
JSON extension You can run the php -m command to check whether the preceding extensions have been installed properly.
On Ubuntu, you can install PHP's extensions using the apt-get package manager with the following command:
sudo apt-get install php-curl php-xml php-dom php-mbstring php-json
On CentOS, you can install PHP's cURL extension using the yum package manager.
sudo yum install php-curl php-xml php-dom php-mbstring php-json

Installing SDK

You can install the SDK using Composer, Phar, or the source code.

Composer

It is recommended to install cos-php-sdk-v5 with Composer, a PHP dependency manager that allows you to declare the dependencies necessary for your project and then automatically installs them into your project.
Note:
You can find more information such as how to install Composer, how to configure auto-load, and other best practices for defining dependencies at the Composer website.
Directions
1. Open the terminal.
2. Run the following command to download Composer:
curl -sS https://getcomposer.org/installer | php
3. Create a file named composer.json with the following content:
{
"require": {
"qcloud/cos-sdk-v5": ">=2.0"
}
}
4. Run the following command to install the SDK with Composer:
php composer.phar install
This command will create a vendor folder in the current directory. The folder will contain the SDK's dependent library and an autoload.php script file for future calls in your project.
Note:
Composer will download Guzzle 6 or Guzzle 7 according to the PHP version. Guzzle 7 supports the Laravel 8 framework. If the PHP version is or later than 7.2.5, Guzzle 7 will be downloaded by default. Otherwise, Guzzle 6 will be downloaded.
5. Run the autoloader script to call cos-php-sdk-v5 and import the autoload.php file into your code.
require '/path/to/sdk/vendor/autoload.php';
Note:
After running the Composer installation command, you need to change the path here to the path to the autoload.php file. Otherwise, the corresponding method cannot be called. For example, if your installation path is /Users/username/project, set the referenced path in the project to /Users/username/project/vendor/autoload.php.
Now, you can use COS XML SDK for PHP in your project.

Phar

Install the SDK using the Phar method as instructed below:
1. Download the phar file here.
Note:
If your PHP version is 5.6 or later and earlier than 7.2.5, download cos-sdk-v5-6.phar to use Guzzle 6.
If your PHP version is 7.2.5 or later, download cos-sdk-v5-7.phar to use Guzzle 7.
2. Import the phar file into your code.
require '/path/to/cos-sdk-v5-x.phar';

Source code

Install the SDK using the source code as instructed below:
1. Download the cos-sdk-v5.tar.gz compressed file on the SDK releases page.
Note:
If your PHP version is 5.6 or later and earlier than 7.2.5, download cos-sdk-v5-6.tar.gz to use Guzzle 6.
If your PHP version is 7.2.5 or later, download cos-sdk-v5-7.tar.gz to use Guzzle 7.
2. Decompress the file and run the autoload.php script to load the SDK and import the autoload.php file into your code:
require '/path/to/sdk/vendor/autoload.php';
Note:
Source code is the default GitHub-compressed code package, which does not include the vendor directory. Note that you should download the release package (cos-sdk-v5-x.tar.gz) rather than the Source package, and should not clone the entire repository (otherwise, index.php and the vendor package will be missing).

Getting Started

The following describes how to use the PHP SDK of COS to perform basic operations, such as initializing the client, creating a bucket, querying the bucket list, uploading an object, querying the object list, downloading an object, and deleting an object. For more information about the parameters involved in the samples, see Bucket Operations and Object Operations.

Initialization

Note:
We recommend you use a sub-account key and environment variables to call the SDK for security purposes. When authorizing a sub-account, follow the Notes on Principle of Least Privilege to avoid leaking resources besides your buckets and objects.
If you must use a permanent key, we recommend you follow the Notes on Principle of Least Privilege to limit the scope of permission on the permanent key.
If you initialize a client with a temporary key, create an instance in the following way.
$tmpSecretId = "TmpSecretId"; //SecretId of a temporary key. For more information about how to generate and use a temporary key, visit https://www.tencentcloud.com/document/product/436/14048.
$tmpSecretKey = "TmpSecretKey"; //SecretKey of a temporary key. For more information about how to generate and use a temporary key, visit https://www.tencentcloud.com/document/product/436/14048.
$tmpToken = "TmpToken"; //Token of a temporary key. For more information about how to generate and use a temporary key, visit https://www.tencentcloud.com/document/product/436/14048?from_cn_redirect=1.
$region = "ap-beijing"; //Replace it with the actual `region`, which can be viewed in the console at https://console.tencentcloud.com/cos5/bucket.
$cosClient = new Qcloud\\Cos\\Client(
array(
'region' => $region,
'schema' => 'https', //Protocol header, which is http by default
'credentials'=> array(
'secretId' => $tmpSecretId,
'secretKey' => $tmpSecretKey,
'token' => $tmpToken)));
If you use a permanent key to initialize a COSClient, you need to get your SecretId and SecretKey on the API Key Management page in the CAM console. A permanent key is suitable for most application scenarios.
// You can log in to the CAM console to view and manage the `SecretId` and `SecretKey` of your project.
$secretId = getenv('COS_SECRET_ID'); // User `SecretId`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit https://www.tencentcloud.com/document/product/598/32675.
$secretKey = getenv('COS_SECRET_KEY'); // User `SecretKey`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit https://www.tencentcloud.com/document/product/598/32675.
$region = "ap-beijing"; //User `region`, which can be viewed in the console at https://console.tencentcloud.com/cos5/bucket.
$cosClient = new Qcloud\\Cos\\Client(
array(
'region' => $region,
'schema' => 'https', // Protocol, which is `http` by default
'credentials'=> array(
'secretId' => $secretId ,
'secretKey' => $secretKey)));
Note:
If no HTTPS certificate is configured, you need to delete the schema parameter or enter 'schema' => 'http'. If you enter https, a certificate problem will be reported. If you want to configure an HTTPS certificate, see PHP SDK FAQs.

Creating a bucket

try {
$bucket = "examplebucket-1250000000"; // Bucket name in the format of BucketName-APPID
$result = $cosClient->createBucket(array('Bucket' => $bucket));
// Request succeeded
print_r($result);
} catch (\\Exception $e) {
// Request failed
echo($e);
}

Querying the bucket list

try {
// Request succeeded
$result = $cosClient->listBuckets();
print_r($result);
} catch (\\Exception $e) {
// Request failed
echo($e);
}

Uploading an object

Note:
Upload a file (up to 5 GB) using the putObject API.
Upload a file using the Upload API. The Upload API is a composition API that uses simple upload for small files and uses multipart upload for large files.
For parameter descriptions, see Object Operations.
# Upload a file
## putObject (an API that can upload files of up to 5 GB)
### Uploading strings in memory
try {
$bucket = "examplebucket-1250000000"; // Bucket name in the format of BucketName-APPID
$key = "exampleobject"; // Object key, the unique identifier of the object in the bucket
$result = $cosClient->putObject(array(
'Bucket' => $bucket,
'Key' => $key,
'Body' => 'Hello World!'));
print_r($result);
} catch (\\Exception $e) {
echo "$e\\n";
}

### Uploading a file stream
try {
$bucket = "examplebucket-1250000000"; // Bucket name in the format of BucketName-APPID
$key = "exampleobject"; // Object key, the unique identifier of the object in the bucket
$srcPath = "path/to/localFile";// Absolute path to local file
$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 (advanced upload API, which can upload files of up to 50 TB with multipart upload)
### Uploading strings in memory
try {
$bucket = "examplebucket-1250000000"; // Bucket name in the format of BucketName-APPID
$key = "exampleobject"; // Object key, the unique identifier of the object in the bucket
$result = $cosClient->Upload(
$bucket = $bucket,
$key = $key,
$body = 'Hello World!');
print_r($result);
} catch (\\Exception $e) {
echo "$e\\n";
}

### Uploading a file stream
try {
$bucket = "examplebucket-1250000000"; // Bucket name in the format of BucketName-APPID
$key = "exampleobject"; // Object key, the unique identifier of the object in the bucket
$srcPath = "path/to/localFile";// Absolute path to local file
$file = fopen($srcPath, 'rb');
if ($file) {
$result = $cosClient->Upload(
$bucket = $bucket,
$key = $key,
$body = $file);
}
print_r($result);
} catch (\\Exception $e) {
echo "$e\\n";
}

Querying objects

try {
$bucket = "examplebucket-1250000000"; // Bucket name in the format of BucketName-APPID
$result = $cosClient->listObjects(array(
'Bucket' => $bucket
));
// Request succeeded
if (isset($result['Contents'])) {
foreach ($result['Contents'] as $rt) {
print_r($rt);
}
}
} catch (\\Exception $e) {
// Request failed
echo($e);
}
A single call to the listObjects API can query up to 1,000 objects. If you want to query all objects, you need to call it repeatedly.
try {
$bucket = "examplebucket-1250000000"; // Bucket name in the format of BucketName-APPID
$prefix = ''; // Prefix of the objects to be listed
$marker = ''; // End marker in the last list
while (true) {
$result = $cosClient->listObjects(array(
'Bucket' => $bucket,
'Marker' => $marker,
'MaxKeys' => 1000 // Set the maximum number of entries to be listed in one single query, which is up to 1,000
));
if (isset($result['Contents'])) {
foreach ($result['Contents'] as $rt) {
// Print key
echo($rt['Key'] . "\\n");
}
}
$marker = $result['NextMarker']; // Set a new end marker
if (!$result['IsTruncated']) {
break; // Determine whether the query is complete
}
}
} catch (\\Exception $e) {
echo($e);
}

Downloading an object

Download a file using the getObject API.
Get the file download URL using the getObjectUrl API.
# Downloading a file
## getObject (download file)
### Download to memory
try {
$bucket = "examplebucket-1250000000"; // Bucket in the format of BucketName-APPID
$key = "exampleobject"; // Object key, the unique identifier of the object in the bucket
$result = $cosClient->getObject(array(
'Bucket' => $bucket,
'Key' => $key));
// Request succeeded
echo($result['Body']);
} catch (\\Exception $e) {
// Request failed
echo "$e\\n";
}

### Download to the local file system
try {
$bucket = "examplebucket-1250000000"; // Bucket in the format of BucketName-APPID
$key = "exampleobject"; // Object key, the unique identifier of the object in the bucket
$localPath = @"path/to/localFile";// Download to a specific local path
$result = $cosClient->getObject(array(
'Bucket' => $bucket,
'Key' => $key,
'SaveAs' => $localPath));
} catch (\\Exception $e) {
// Request failed
echo "$e\\n";
}

### Specifying the download range
/*
* Range field is in the format of 'bytes=a-b'
*/
try {
$bucket = "examplebucket-1250000000"; // Bucket in the format of BucketName-APPID
$key = "exampleobject"; // Object key, the unique identifier of the object in the bucket
$localPath = @"path/to/localFile";// Download to a specific local path
$result = $cosClient->getObject(array(
'Bucket' => $bucket,
'Key' => $key,
'Range' => 'bytes=0-10',
'SaveAs' => $localPath));
} catch (\\Exception $e) {
// Request failed
echo "$e\\n";
}

## getObjectUrl (get the file URL)
try {
$bucket = "examplebucket-1250000000"; // Bucket in the format of BucketName-APPID
$key = "exampleobject"; // Object key, the unique identifier of the object in the bucket
$signedUrl = $cosClient->getObjectUrl($bucket, $key, '+10 minutes');
// Request succeeded
echo $signedUrl;
} catch (\\Exception $e) {
// Request failed
print_r($e);
}

Deleting an object

# Delete an object
## deleteObject
try {
$bucket = "examplebucket-1250000000"; // Bucket in the format of BucketName-APPID
$key = "exampleobject"; // Object key, the unique identifier of the object in the bucket
$result = $cosClient->deleteObject(array(
'Bucket' => $bucket,
'Key' => $key,
'VersionId' => 'string'
));
// Request succeeded
print_r($result);
} catch (\\Exception $e) {
// Request failed
echo($e);
}
# Delete multiple objects
## deleteObjects
try {
$bucket = "examplebucket-1250000000"; // Bucket in the format of BucketName-APPID
$key1 = "exampleobject1"; // Object key, the unique identifier of the object in the bucket
$key2 = "exampleobject2"; // Object key, the unique identifier of the object in the bucket
$result = $cosClient->deleteObjects(array(
'Bucket' => $bucket,
'Objects' => array(
array(
'Key' => $key1,
),
array(
'Key' => $key2,
),
//...
),
));
// Request succeeded
print_r($result);
} catch (\\Exception $e) {
// Request failed
echo($e);
}


Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan