All Products
Document Center

Object Storage Service:Perform range download by using OSS SDK for PHP

Last Updated:Mar 11, 2024

You can use range download to download data within a specific range in an Object Storage Service (OSS) object.

Usage notes

  • In this topic, the public endpoint of the China (Hangzhou) region is used. If you want to access OSS from other Alibaba Cloud services in the same region as OSS, use an internal endpoint. For more information about OSS regions and endpoints, see Regions and endpoints.

  • In this topic, an OSSClient instance is created by using an OSS endpoint. If you want to create an OSSClient instance by using custom domain names or Security Token Service (STS), see Create an OSSClient instance.

  • To perform range download, you must have the oss:GetObject permission. For more information, see Attach a custom policy to a RAM user.


The following sample code provides an example on how to download data within the range from byte 0 to byte 4 in an object to local memory:

if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured. 
$provider = new EnvironmentVariableCredentialsProvider();
// In this example, the endpoint of the China (Hangzhou) region is used. Specify the endpoint based on your business requirements. 
$endpoint = "";
$bucket= "yourBucketName";
$object = "yourObjectName";
//Download data within the range from byte 0 to byte 4. This range has a total of 5 bytes of data. If the specified range is invalid, the entire object is downloaded. For example, if the start or end value of the specified range is a negative number or is greater than the object size, all data of the object is downloaded. 
$options = array(OssClient::OSS_RANGE => '0-4');
    $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    $ossClient = new OssClient($config);

    $content = $ossClient->getObject($bucket, $object, $options);
} catch(OssException $e) {
    printf(__FUNCTION__ . ": FAILED\n");
    printf($e->getMessage() . "\n");
print ($content);
print(__FUNCTION__ . ": OK" . "\n");