Help Center/ Object Storage Service/ SDK Reference/ PHP/ Bucket APIs/ Basic Operations/ Setting or Obtaining a Bucket Quota
Updated on 2026-09-22 GMT+08:00
View PDF
Share

Setting or Obtaining a Bucket Quota

If you have any questions during development, post them on the Issues page of GitHub. For details about parameters and usage of each API, see API Reference.

Setting a Bucket Quota

You can call ObsClient->setBucketQuota to set the bucket quota. Sample code is as follows:

<?php

// Import the dependency library.
require 'vendor/autoload.php';
// Import the SDK code library during the installation with the source code.
// require 'obs-autoloader.php';
// Declare the namespace.
use Obs\ObsClient;
use Obs\ObsException;
// Create an ObsClient instance.
$obsClient = new ObsClient([ 
    // Obtain an AK/SK pair using environment variables (recommended) or import an AK/SK pair in other ways. Using hard coding may result in leakage.
    //Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
    'key' => getenv('ACCESS_KEY_ID'),
    'secret' => getenv('SECRET_ACCESS_KEY'),
    'endpoint' => 'https://your-endpoint',
]);

try {
    // Set the bucket quota.
    $resp = $obsClient->setBucketQuota([
        'Bucket' => "bucketname",
        'StorageQuota' => 1024 * 1024 * 100  // 100MB
    ]);

    printf("RequestId:%s\n",$resp['RequestId']);
} catch (ObsException $e) {
      // If the operation fails, obtain the exception details.
      printf("SetBucketQuotaFailed: Status:%d, Code:%s, Message:%s\n",
         $e->getStatusCode(), $e->getExceptionCode(), $e->getExceptionMessage());
} finally {
      // Close ObsClient to release resources.
      $obsClient->close();
}
  • Use the StorageQuota parameter to specify the bucket quota.
  • A bucket quota must be a non-negative integer expressed in bytes. The maximum value is 263 - 1.

Obtaining a Bucket Quota

You can call ObsClient->getBucketQuota to obtain the bucket quota. Sample code is as follows:

<?php

// Import the dependency library.
require 'vendor/autoload.php';
// Import the SDK code library during the installation with the source code.
// require 'obs-autoloader.php';
// Declare the namespace.
use Obs\ObsClient;
use Obs\ObsException;
// Create an ObsClient instance.
$obsClient = new ObsClient([ 
    // Obtain an AK/SK pair using environment variables (recommended) or import an AK/SK pair in other ways. Using hard coding may result in leakage.
    //Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
    'key' => getenv('ACCESS_KEY_ID'),
    'secret' => getenv('SECRET_ACCESS_KEY'),
    'endpoint' => 'https://your-endpoint',
]);

try {
    // Obtain the bucket quota.
    $resp = $obsClient->getBucketQuota([
        'Bucket' => "bucketname",
        'StorageQuota' => 1024 * 1024 * 100  // 100MB
    ]);

    printf("RequestId:%s\n",$resp['RequestId']);
    printf("StorageQuota:%s\n",$resp['StorageQuota']);
} catch (ObsException $e) {
      // If the operation fails, obtain the exception details.
      printf("GetBucketQuotaFailed: Status:%d, Code:%s, Message:%s\n",
         $e->getStatusCode(), $e->getExceptionCode(), $e->getExceptionMessage());
} finally {
      // Close ObsClient to release resources.
      $obsClient->close();
}
Parent topic: Basic Operations